Class TableUpdateSpecV1

java.lang.Object

com.kingsrook.qqq.middleware.javalin.specs.AbstractEndpointSpec<TableUpdateInput,TableUpdateResponseV1,TableUpdateExecutor>

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

public class TableUpdateSpecV1
extends AbstractEndpointSpec<TableUpdateInput,TableUpdateResponseV1,TableUpdateExecutor>

Field Summary

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

qInstance

Constructor Summary

Constructors

Constructor	Description
TableUpdateSpecV1()

Method Summary

Modifier and Type	Method	Description
TableUpdateInput	buildInput(io.javalin.http.Context context)	Read the changed values from a JSON object body, or from multipart form fields (uploaded files for blob fields, and an `associations` field), the same way the legacy update route does - after the edit permission check, so a refused request is not read (an unknown table is refused the same way).
List<BasicResponse>	defineAdditionalBasicResponses()	The stale-version response is a documented, structured HTTP 409.
BasicOperation	defineBasicOperation()
BasicResponse	defineBasicSuccessResponse()
Map<String,Schema>	defineComponentSchemas()
RequestBody	defineRequestBody()
List<Parameter>	defineRequestParameters()
protected void	handleException(io.javalin.http.Context context, Exception exception)	Only version conflicts change the existing error mapping.

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

checkCredentialScopeOperation, customizeMethod, defineCompleteOperation, defineMethod, defineResponses, defineRoute, getOperationId, getRequestBodyAsJsonObject, getRequestParam, getRequestParamInteger, getRequestParamMap, handleOutput, 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

TableUpdateSpecV1

public TableUpdateSpecV1()

Method Details

defineBasicOperation

public BasicOperation defineBasicOperation()

Overrides:

defineBasicOperation in class AbstractEndpointSpec<TableUpdateInput,TableUpdateResponseV1,TableUpdateExecutor>

defineRequestParameters

public List<Parameter> defineRequestParameters()

Overrides:

defineRequestParameters in class AbstractEndpointSpec<TableUpdateInput,TableUpdateResponseV1,TableUpdateExecutor>

defineRequestBody

public RequestBody defineRequestBody()

Overrides:

defineRequestBody in class AbstractEndpointSpec<TableUpdateInput,TableUpdateResponseV1,TableUpdateExecutor>

buildInput

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

Read the changed values from a JSON object body, or from multipart form fields (uploaded files for blob fields, and an `associations` field), the same way the legacy update route does - after the edit permission check, so a refused request is not read (an unknown table is refused the same way).

Specified by:

buildInput in class AbstractEndpointSpec<TableUpdateInput,TableUpdateResponseV1,TableUpdateExecutor>

Throws:

Exception

defineComponentSchemas

public Map<String,Schema> defineComponentSchemas()

Overrides:

defineComponentSchemas in class AbstractEndpointSpec<TableUpdateInput,TableUpdateResponseV1,TableUpdateExecutor>

defineBasicSuccessResponse

public BasicResponse defineBasicSuccessResponse()

Overrides:

defineBasicSuccessResponse in class AbstractEndpointSpec<TableUpdateInput,TableUpdateResponseV1,TableUpdateExecutor>

defineAdditionalBasicResponses

public List<BasicResponse> defineAdditionalBasicResponses()

The stale-version response is a documented, structured HTTP 409.

Overrides:

defineAdditionalBasicResponses in class AbstractEndpointSpec<TableUpdateInput,TableUpdateResponseV1,TableUpdateExecutor>

handleException

protected void handleException(io.javalin.http.Context context,
 Exception exception)

Only version conflicts change the existing error mapping.

Overrides:

handleException in class AbstractEndpointSpec<TableUpdateInput,TableUpdateResponseV1,TableUpdateExecutor>