Class AvatarLookupSpecV1

java.lang.Object

com.kingsrook.qqq.middleware.javalin.specs.AbstractEndpointSpec<AbstractMiddlewareInput,AbstractMiddlewareOutputInterface,AbstractMiddlewareExecutor<AbstractMiddlewareInput,AbstractMiddlewareOutputInterface>>

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

public class AvatarLookupSpecV1
extends AbstractEndpointSpec<AbstractMiddlewareInput,AbstractMiddlewareOutputInterface,AbstractMiddlewareExecutor<AbstractMiddlewareInput,AbstractMiddlewareOutputInterface>>

POST /avatars/lookup: the avatar URLs of up to 200 users, by user id, for any signed-in user. A POST, so user ids (often emails) are never in a URL or an access log. Users without an avatar are left out. Since UI API 1.8.0.

Field Summary

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

qInstance

Constructor Summary

Constructors

Constructor	Description
AvatarLookupSpecV1()

Method Summary

Modifier and Type	Method	Description
AbstractMiddlewareInput	buildInput(io.javalin.http.Context context)	No input: serveRequest is overridden.
BasicOperation	defineBasicOperation()
BasicResponse	defineBasicSuccessResponse()
Map<String,Schema>	defineComponentSchemas()
RequestBody	defineRequestBody()
AbstractMiddlewareOutputInterface	serveRequest(AbstractMiddlewareVersion abstractMiddlewareVersion, io.javalin.http.Context context)	Answer directly (no executor).

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

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

Methods inherited from class java.lang.Object

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

Constructor Details

AvatarLookupSpecV1

public AvatarLookupSpecV1()

Method Details

defineBasicOperation

public BasicOperation defineBasicOperation()

Overrides:

defineBasicOperation in class AbstractEndpointSpec<AbstractMiddlewareInput,AbstractMiddlewareOutputInterface,AbstractMiddlewareExecutor<AbstractMiddlewareInput,AbstractMiddlewareOutputInterface>>

defineRequestBody

public RequestBody defineRequestBody()

Overrides:

defineRequestBody in class AbstractEndpointSpec<AbstractMiddlewareInput,AbstractMiddlewareOutputInterface,AbstractMiddlewareExecutor<AbstractMiddlewareInput,AbstractMiddlewareOutputInterface>>

defineComponentSchemas

public Map<String,Schema> defineComponentSchemas()

Overrides:

defineComponentSchemas in class AbstractEndpointSpec<AbstractMiddlewareInput,AbstractMiddlewareOutputInterface,AbstractMiddlewareExecutor<AbstractMiddlewareInput,AbstractMiddlewareOutputInterface>>

defineBasicSuccessResponse

public BasicResponse defineBasicSuccessResponse()

Overrides:

defineBasicSuccessResponse in class AbstractEndpointSpec<AbstractMiddlewareInput,AbstractMiddlewareOutputInterface,AbstractMiddlewareExecutor<AbstractMiddlewareInput,AbstractMiddlewareOutputInterface>>

buildInput

public AbstractMiddlewareInput buildInput(io.javalin.http.Context context)

No input: serveRequest is overridden.

Specified by:

buildInput in class AbstractEndpointSpec<AbstractMiddlewareInput,AbstractMiddlewareOutputInterface,AbstractMiddlewareExecutor<AbstractMiddlewareInput,AbstractMiddlewareOutputInterface>>

serveRequest

public AbstractMiddlewareOutputInterface serveRequest(AbstractMiddlewareVersion abstractMiddlewareVersion,
 io.javalin.http.Context context)
                                               throws Exception

Answer directly (no executor).

Overrides:

serveRequest in class AbstractEndpointSpec<AbstractMiddlewareInput,AbstractMiddlewareOutputInterface,AbstractMiddlewareExecutor<AbstractMiddlewareInput,AbstractMiddlewareOutputInterface>>

Throws:

Exception