Class VersionSpecV1

java.lang.Object

com.kingsrook.qqq.middleware.javalin.specs.AbstractEndpointSpec<VersionInput,VersionResponseV1,VersionExecutor>

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

public class VersionSpecV1
extends AbstractEndpointSpec<VersionInput,VersionResponseV1,VersionExecutor>

GET /version - the UI API semantic version, features and extensions.

Field Summary

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

qInstance

Constructor Summary

Constructors

Constructor	Description
VersionSpecV1()

Method Summary

Modifier and Type	Method	Description
VersionInput	buildInput(io.javalin.http.Context context)	build the endpoint's input object from a javalin context
BasicOperation	defineBasicOperation()
BasicResponse	defineBasicSuccessResponse()
Map<String,Schema>	defineComponentSchemas()
void	defineRoute(AbstractMiddlewareVersion abstractMiddlewareVersion, String versionBasePath)	remember which version this spec is bound into, for the executor
boolean	isSecured()

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

checkCredentialScopeOperation, customizeMethod, defineAdditionalBasicResponses, defineCompleteOperation, defineMethod, defineRequestBody, defineRequestParameters, defineResponses, getOperationId, getRequestBodyAsJsonObject, getRequestParam, getRequestParamInteger, getRequestParamMap, handleException, handleOutput, newExecutor, newOutput, serveRequest, setQInstance

Methods inherited from class java.lang.Object

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

Constructor Details

VersionSpecV1

public VersionSpecV1()

Method Details

defineBasicOperation

public BasicOperation defineBasicOperation()

Overrides:

defineBasicOperation in class AbstractEndpointSpec<VersionInput,VersionResponseV1,VersionExecutor>

isSecured

public boolean isSecured()

Overrides:

isSecured in class AbstractEndpointSpec<VersionInput,VersionResponseV1,VersionExecutor>

defineRoute

public void defineRoute(AbstractMiddlewareVersion abstractMiddlewareVersion,
 String versionBasePath)

remember which version this spec is bound into, for the executor

Overrides:

defineRoute in class AbstractEndpointSpec<VersionInput,VersionResponseV1,VersionExecutor>

buildInput

public VersionInput buildInput(io.javalin.http.Context context)
                        throws Exception

Description copied from class: AbstractEndpointSpec

build the endpoint's input object from a javalin context

Specified by:

buildInput in class AbstractEndpointSpec<VersionInput,VersionResponseV1,VersionExecutor>

Throws:

Exception

defineComponentSchemas

public Map<String,Schema> defineComponentSchemas()

Overrides:

defineComponentSchemas in class AbstractEndpointSpec<VersionInput,VersionResponseV1,VersionExecutor>

defineBasicSuccessResponse

public BasicResponse defineBasicSuccessResponse()

Overrides:

defineBasicSuccessResponse in class AbstractEndpointSpec<VersionInput,VersionResponseV1,VersionExecutor>