Class AvatarGetSpecV1

java.lang.Object

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

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

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

GET /avatars/{avatarId}: an avatar image by its opaque id (never a user id or email), for any signed-in user (avatars appear beside comments, presence and mentions; POST /avatars/lookup maps user ids to avatar URLs). 404 when there is none: clients then draw initials. A chosen Gravatar is fetched and re-encoded by the server. 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
AvatarGetSpecV1()

Method Summary

Modifier and Type	Method	Description
AbstractMiddlewareInput	buildInput(io.javalin.http.Context context)	No input: serveRequest is overridden.
BasicOperation	defineBasicOperation()
Map<String,Schema>	defineComponentSchemas()
List<Parameter>	defineRequestParameters()
Map<Integer,Response>	defineResponses()
AbstractMiddlewareOutputInterface	serveRequest(AbstractMiddlewareVersion abstractMiddlewareVersion, io.javalin.http.Context context)	Serve the image (no executor).

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

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

AvatarGetSpecV1

public AvatarGetSpecV1()

Method Details

defineBasicOperation

public BasicOperation defineBasicOperation()

Overrides:

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

defineRequestParameters

public List<Parameter> defineRequestParameters()

Overrides:

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

defineResponses

public Map<Integer,Response> defineResponses()

Overrides:

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

defineComponentSchemas

public Map<String,Schema> defineComponentSchemas()

Overrides:

defineComponentSchemas 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

Serve the image (no executor).

Overrides:

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

Throws:

Exception