Class HelpCoverageSpecV1

java.lang.Object

com.kingsrook.qqq.middleware.javalin.specs.AbstractEndpointSpec<HelpCoverageMiddlewareInput,HelpCoverageResponseV1,HelpCoverageExecutor>

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

public class HelpCoverageSpecV1
extends AbstractEndpointSpec<HelpCoverageMiddlewareInput,HelpCoverageResponseV1,HelpCoverageExecutor>

HelpCoverageSpecV1 contract.

Field Summary

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

qInstance

Constructor Summary

Constructors

Constructor	Description
HelpCoverageSpecV1()

Method Summary

Modifier and Type	Method	Description
HelpCoverageMiddlewareInput	buildInput(io.javalin.http.Context context)	Parse input; malformed parameters receive HTTP 400.
List<BasicResponse>	defineAdditionalBasicResponses()	Coverage requires an author permission on helpContent.
BasicOperation	defineBasicOperation()	Describe the secured help endpoint.
BasicResponse	defineBasicSuccessResponse()	Success response.
Map<String,Schema>	defineComponentSchemas()	Response schema.
List<Parameter>	defineRequestParameters()	Query parameters.
void	handleOutput(io.javalin.http.Context context, HelpCoverageResponseV1 output)	Serialize the public response.

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

checkCredentialScopeOperation, customizeMethod, 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

HelpCoverageSpecV1

public HelpCoverageSpecV1()

Method Details

defineBasicOperation

public BasicOperation defineBasicOperation()

Describe the secured help endpoint.

Overrides:

defineBasicOperation in class AbstractEndpointSpec<HelpCoverageMiddlewareInput,HelpCoverageResponseV1,HelpCoverageExecutor>

defineRequestParameters

public List<Parameter> defineRequestParameters()

Query parameters.

Overrides:

defineRequestParameters in class AbstractEndpointSpec<HelpCoverageMiddlewareInput,HelpCoverageResponseV1,HelpCoverageExecutor>

buildInput

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

Parse input; malformed parameters receive HTTP 400.

Specified by:

buildInput in class AbstractEndpointSpec<HelpCoverageMiddlewareInput,HelpCoverageResponseV1,HelpCoverageExecutor>

Throws:

Exception

defineComponentSchemas

public Map<String,Schema> defineComponentSchemas()

Response schema.

Overrides:

defineComponentSchemas in class AbstractEndpointSpec<HelpCoverageMiddlewareInput,HelpCoverageResponseV1,HelpCoverageExecutor>

defineBasicSuccessResponse

public BasicResponse defineBasicSuccessResponse()

Success response.

Overrides:

defineBasicSuccessResponse in class AbstractEndpointSpec<HelpCoverageMiddlewareInput,HelpCoverageResponseV1,HelpCoverageExecutor>

handleOutput

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

Serialize the public response.

Overrides:

handleOutput in class AbstractEndpointSpec<HelpCoverageMiddlewareInput,HelpCoverageResponseV1,HelpCoverageExecutor>

Throws:

Exception

defineAdditionalBasicResponses

public List<BasicResponse> defineAdditionalBasicResponses()

Coverage requires an author permission on helpContent.

Overrides:

defineAdditionalBasicResponses in class AbstractEndpointSpec<HelpCoverageMiddlewareInput,HelpCoverageResponseV1,HelpCoverageExecutor>