Class TableVariantsSpecV1

java.lang.Object

com.kingsrook.qqq.middleware.javalin.specs.AbstractEndpointSpec<TableVariantsInput,TableVariantsResponseV1,TableVariantsExecutor>

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

public class TableVariantsSpecV1
extends AbstractEndpointSpec<TableVariantsInput,TableVariantsResponseV1,TableVariantsExecutor>

Spec for listing the variants of a table whose backend uses variants (GET /table/{tableName}/variants) - the v1 form of the legacy variants route.

Field Summary

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

qInstance

Constructor Summary

Constructors

Constructor	Description
TableVariantsSpecV1()

Method Summary

Modifier and Type	Method	Description
TableVariantsInput	buildInput(io.javalin.http.Context context)	build the endpoint's input object from a javalin context
BasicOperation	defineBasicOperation()
BasicResponse	defineBasicSuccessResponse()
Map<String,Schema>	defineComponentSchemas()
List<Parameter>	defineRequestParameters()
void	handleOutput(io.javalin.http.Context context, TableVariantsResponseV1 output)	Always include the list, so a table without variants answers an empty one.

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

checkCredentialScopeOperation, customizeMethod, defineAdditionalBasicResponses, defineCompleteOperation, defineMethod, defineRequestBody, 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

TableVariantsSpecV1

public TableVariantsSpecV1()

Method Details

defineBasicOperation

public BasicOperation defineBasicOperation()

Overrides:

defineBasicOperation in class AbstractEndpointSpec<TableVariantsInput,TableVariantsResponseV1,TableVariantsExecutor>

defineRequestParameters

public List<Parameter> defineRequestParameters()

Overrides:

defineRequestParameters in class AbstractEndpointSpec<TableVariantsInput,TableVariantsResponseV1,TableVariantsExecutor>

buildInput

public TableVariantsInput 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<TableVariantsInput,TableVariantsResponseV1,TableVariantsExecutor>

Throws:

Exception

defineComponentSchemas

public Map<String,Schema> defineComponentSchemas()

Overrides:

defineComponentSchemas in class AbstractEndpointSpec<TableVariantsInput,TableVariantsResponseV1,TableVariantsExecutor>

defineBasicSuccessResponse

public BasicResponse defineBasicSuccessResponse()

Overrides:

defineBasicSuccessResponse in class AbstractEndpointSpec<TableVariantsInput,TableVariantsResponseV1,TableVariantsExecutor>

handleOutput

public void handleOutput(io.javalin.http.Context context,
 TableVariantsResponseV1 output)
                  throws Exception

Always include the list, so a table without variants answers an empty one.

Overrides:

handleOutput in class AbstractEndpointSpec<TableVariantsInput,TableVariantsResponseV1,TableVariantsExecutor>

Throws:

Exception