Images

List of Endpoints

• /upload/image: Handled by image_upload().
• /upload/image/overlay: Handled by image_upload_with_overlay().

API Reference

images.delete_image()

Deletes an image from Cloud Storage. Requires “post_id” url parameter.

Returns:

• 204 - Image successfully deleted.
• 400 - Missing post_id url parameter or no such image found.

images.image_upload()

Endpoint for just image upload.

Expects form data fields “post_id”, “ext” and “content-type” which are used to save the output name. Expects image to be uploaded as multipart/file-upload and accessible under the name “image”.

Returns:

• 204 - No content.
• 400 - Missing data field.
• 5XX - Request too large.

images.image_upload_with_overlay()

Endpoint for image + overlay upload. Has an additional form data field “overlay” that is required.

Returns:

• 204 - No content.
• 400 - Missing data field.
• 5XX - Request too large.

images.setup_routing(app: flask.app.Flask)

Basic routing function for flask.

Parameters:app (flask.Flask) – Your flask application object.