Skip to content

API Documentation

CodingInRhythm edited this page Apr 7, 2021 · 2 revisions

API Routes


  • The ToDoomList App uses the following API routes to dynamically update the page to create a single-page-app-like feel for the user for specific features.

Schemes


C.R.U.D Operations:

1. CREATE:

  • A logged-in Villain may create one of their own Schemes, adding it to the side panel of visible Schemes ((without causing a refresh/redirect)).
    • POST /app/schemes/

2. READ:

  • A logged-in and authorized Villain is able to see a side panel populate with all of their Schemes and gives the Villain their first Scheme in alphabetical order.
    • GET /app/schemes/:schemeid

UPDATE:

  • A logged-in Villain may rename their own Schemes however they wish.
    • PUT /app/:schemeid

DELETE:

  • A logged-in and authorized Villain is able to remove one of their own Schemes, removing it from the side panel of visible Schemes.
    • DELETE /app/:schemeid


Ploys


C.R.U.D Operations:

CREATE:

  • A logged-in and authorized Villain is able to access one of their Schemes and add a Ploy to that specific Scheme.
    • POST /app/schemes/:schemeid/

READ:

  • A logged-in and authorized Vilain is able to access one of their Schemes and view all of the Ploys that belong to that Scheme.
    • GET /app/ploys/:ployid/

Update:

  • A logged-in and authorized Vilain is able to access one of their Schemes and rename any of the Ploys that belong to that Scheme
    • PUT /app/ploys/:ployid

Delete:

  • A logged-in and authorized Vilain is able to access one of their Schemes and remove any of the Ploys that belong to that Scheme.
    • DELETE /app/ploy/:ployid

Clone this wiki locally