Struct Upload

pub struct Upload;

Upload an image.

Flow:

1. User requests an upload session URI directly to Google Cloud Storage a. User uploads to processing bucket
2. Firestore is notified of processing = true, ready = false status at document uploads/media/global/{id}
3. Image is processed and uploaded to the final bucket
4. Firestore is notified of processing = true, ready = true status at document uploads/media/global/{id}

Notes:

• Can be used to update the raw data associated with the image.
• If the client wants to re-upload an image after it has been successfully processed, it must repeat the entire flow instead of uploading to the same session URI.

Errors:

• 400 - BadRequest if the request is invalid.
• 401 - Unauthorized if authorization is not valid. This may be an API server issue, see #1209.
• 403 - Forbidden if the user does not have sufficient permission to perform the action.
• 501 - NotImplemented when the s3/gcs service is disabled.

Trait Implementations

impl ApiEndpoint for Upload

const METHOD: Method = Method::Put

The method used to make a request to the endpoint.

type Req = ImageUploadRequest

The request type for this endpoint.

type Res = ImageUploadResponse

The response type for this endpoint.

type Path = ImageUploadPath

The path type for this endpoint.

type Err = EmptyError

The (inner) error type for this endpoint.