Class TableApiDocumentSpecV1

java.lang.Object

com.kingsrook.qqq.middleware.javalin.specs.AbstractEndpointSpec<AbstractJsonEndpointSpec.JsonInput,AbstractJsonEndpointSpec.JsonOutput,AbstractJsonEndpointSpec.JsonExecutor>

com.kingsrook.qqq.middleware.javalin.specs.extensions.AbstractJsonEndpointSpec

com.kingsrook.qqq.middleware.javalin.specs.v1.TableApiDocumentSpecV1

public class TableApiDocumentSpecV1
extends AbstractJsonEndpointSpec

GET /table/{tableName}/apis/{apiName}/{version}/openapi: the table's OpenAPI document in one version of an application API (one listed by GET /table/{tableName}/apis), for the developer views - so they read it through the UI API rather than from the API middleware's {api.path}{version}/{table}/openapi.json. The document comes from the TableApisProviderInterface that serves the API.

Nested Class Summary

Nested classes/interfaces inherited from class com.kingsrook.qqq.middleware.javalin.specs.extensions.AbstractJsonEndpointSpec

AbstractJsonEndpointSpec.JsonExecutor, AbstractJsonEndpointSpec.JsonInput, AbstractJsonEndpointSpec.JsonOutput, AbstractJsonEndpointSpec.JsonOutputInterface

Field Summary

Fields inherited from class com.kingsrook.qqq.middleware.javalin.specs.AbstractEndpointSpec

qInstance

Constructor Summary

Constructors

Constructor	Description
TableApiDocumentSpecV1()

Method Summary

Modifier and Type	Method	Description
BasicOperation	defineBasicOperation()
Map<String,Schema>	defineComponentSchemas()
List<Parameter>	defineRequestParameters()
protected String	getResponseSchemaName()	The component schema name of the 200 response body.
protected Object	handle(AbstractJsonEndpointSpec.JsonInput input)	Do the operation's work (the QContext has the session for a secured spec) and return the response body (serialized to JSON).

Methods inherited from class com.kingsrook.qqq.middleware.javalin.specs.extensions.AbstractJsonEndpointSpec

buildInput, defineBasicSuccessResponse, defineRequestBody, defineRequestBodySchema, handleOutput

Methods inherited from class com.kingsrook.qqq.middleware.javalin.specs.AbstractEndpointSpec

checkCredentialScopeOperation, customizeMethod, defineAdditionalBasicResponses, defineCompleteOperation, defineMethod, defineResponses, defineRoute, getOperationId, getRequestBodyAsJsonObject, getRequestParam, getRequestParamInteger, getRequestParamMap, handleException, isSecured, newExecutor, newOutput, serveRequest, setQInstance

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

TableApiDocumentSpecV1

public TableApiDocumentSpecV1()

Method Details

defineBasicOperation

public BasicOperation defineBasicOperation()

Overrides:

defineBasicOperation in class AbstractEndpointSpec<AbstractJsonEndpointSpec.JsonInput,AbstractJsonEndpointSpec.JsonOutput,AbstractJsonEndpointSpec.JsonExecutor>

defineRequestParameters

public List<Parameter> defineRequestParameters()

Overrides:

defineRequestParameters in class AbstractEndpointSpec<AbstractJsonEndpointSpec.JsonInput,AbstractJsonEndpointSpec.JsonOutput,AbstractJsonEndpointSpec.JsonExecutor>

getResponseSchemaName

protected String getResponseSchemaName()

Description copied from class: AbstractJsonEndpointSpec

The component schema name of the 200 response body.

Specified by:

getResponseSchemaName in class AbstractJsonEndpointSpec

defineComponentSchemas

public Map<String,Schema> defineComponentSchemas()

Overrides:

defineComponentSchemas in class AbstractEndpointSpec<AbstractJsonEndpointSpec.JsonInput,AbstractJsonEndpointSpec.JsonOutput,AbstractJsonEndpointSpec.JsonExecutor>

handle

protected Object handle(AbstractJsonEndpointSpec.JsonInput input)
                 throws Exception

Description copied from class: AbstractJsonEndpointSpec

Do the operation's work (the QContext has the session for a secured spec) and return the response body (serialized to JSON).

Specified by:

handle in class AbstractJsonEndpointSpec

Throws:

Exception