Class UploadsSpecV1

java.lang.Object

com.kingsrook.qqq.middleware.javalin.specs.AbstractEndpointSpec<UploadsInput,UploadRefResponseV1,UploadsExecutor>

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

public class UploadsSpecV1
extends AbstractEndpointSpec<UploadsInput,UploadRefResponseV1,UploadsExecutor>

POST /uploads: stream a file into the uploads storage table and get an opaque UploadRef (spec section 3.2) to pass to a job launch (uploadRefs) or to the bulk-load operations. Send multipart form data with one file field, or the raw file as the body with a fileName query parameter (streamed, never buffered whole).

Field Summary

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

qInstance

Constructor Summary

Constructors

Constructor	Description
UploadsSpecV1()

Method Summary

Modifier and Type	Method	Description
UploadsInput	buildInput(io.javalin.http.Context context)	build the endpoint's input object from a javalin context
BasicOperation	defineBasicOperation()
BasicResponse	defineBasicSuccessResponse()
Map<String,Schema>	defineComponentSchemas()
RequestBody	defineRequestBody()
List<Parameter>	defineRequestParameters()

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

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

UploadsSpecV1

public UploadsSpecV1()

Method Details

defineBasicOperation

public BasicOperation defineBasicOperation()

Overrides:

defineBasicOperation in class AbstractEndpointSpec<UploadsInput,UploadRefResponseV1,UploadsExecutor>

defineRequestParameters

public List<Parameter> defineRequestParameters()

Overrides:

defineRequestParameters in class AbstractEndpointSpec<UploadsInput,UploadRefResponseV1,UploadsExecutor>

defineRequestBody

public RequestBody defineRequestBody()

Overrides:

defineRequestBody in class AbstractEndpointSpec<UploadsInput,UploadRefResponseV1,UploadsExecutor>

buildInput

public UploadsInput 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<UploadsInput,UploadRefResponseV1,UploadsExecutor>

Throws:

Exception

defineComponentSchemas

public Map<String,Schema> defineComponentSchemas()

Overrides:

defineComponentSchemas in class AbstractEndpointSpec<UploadsInput,UploadRefResponseV1,UploadsExecutor>

defineBasicSuccessResponse

public BasicResponse defineBasicSuccessResponse()

Overrides:

defineBasicSuccessResponse in class AbstractEndpointSpec<UploadsInput,UploadRefResponseV1,UploadsExecutor>