spaceninja
commented
1 year ago Suggestion: Add the following endpoint:
POST /api/shake_id/(int: shakeid)
(this should also be available on the /api/shake_name and /api/shake_user endpoints.)
Updates a shake's editable details
Note that name in this case refers to the URL path to the shake. e.g., for https://mltshp.com/weloveamberandandre the pathname is weloveamberandandre.
Form Parameters
- title - text for the shake title
- name - text for the shake name
- description - text for the shake description (optional)
Status Codes 200 OK – the response is a shake for the requested shake
- 403 Forbidden – the shake could not be updated due to permission issues
- 404 Not Found – no such shake
We'll also need an endpoint to upload a thumbnail for a shake:
POST /api/shake_id/(int: shakeid)/thumbnail
(this should also be available on the /api/shake_name and /api/shake_user endpoints.)
Sets the submitted image as the thumbnail for a shake. Images should be provided as multipart/form-data request bodies.
Parameters
- shakeid – the shake’s numeric ID
Form Parameters
- file - the file data of the image to upload
Status Codes 200 OK – the response is a shake for the requested shake
- 403 Forbidden – the shake could not be updated due to permission issues
- 404 Not Found – no such shake
It may make sense to merge these together into a single "edit shake" endpoint, but given the complexities around uploading images as multipart/form-data, it might make sense to keep the simpler endpoint for just editing the shake details.
On MLTSHP.com you can edit a shake's name, description, and thumbnail. This is not exposed in the API.