SJRK-416: Make server endpoints more RESTful

Metadata

Source
SJRK-416
Type
Improvement
Priority
Major
Status
Closed
Resolution
Fixed
Assignee
N/A
Reporter
Gregor Moss
Created
2020-10-26T16:23:58.281-0400
Updated
2022-07-29T00:09:25.773-0400
Versions
N/A
Fixed Versions
N/A
Component
  1. Storytelling Tool Server
  2. Storytelling Tool UI

Description

In response to this piece of review left by @@Justin Obara on the pull request for SJRK-289, the server endpoints for getting, saving and editing stories should be adjusted to be more RESTful and internally consistent with respect to the routes for stories and files. This work will also require updating the client side to call the correct endpoints.

@@Justin Obara's original comments from October 5, 2020:

Should review the end points for proper RESTful semantics. In this case POST to create a story makes sense. However uploading a file would likely be better to POST to /stories/:id/files. Updating specific files, or stories can use PUT and deleting a file or story can use DELETE.

Comments

  • Justin Obara commented 2020-11-09T09:27:52.033-0500

    We should review all of the end points ensure that they follow proper RESTful semantics

  • Justin Obara commented 2020-11-18T07:45:23.054-0500

    This Google Sheet provides a summary of the current endpoints.

  • Gregor Moss commented 2020-12-14T14:38:03.857-0500

    Consider doing this work and SJRK-441 at the same time