API Documentation - minuminukim/crates GitHub Wiki

Authentication

• POST /session Logs a user in
• DELETE /session Logs a user out
• GET /session Restores the session user

Users

• POST /users Registers a new user
• GET /users/:userID Returns a user's information
• GET /users/:userID/reviews Returns a user's reviews
• GET /users/:userID/lists Returns a user's lists
• GET /users/:userID/backlog Returns a user's backlog
• PUT /users/:userID/backlog/ Adds an item to a user's backlog
• DELETE /users/:userID/backlog/:albumID Removes an album from a user's backlog
• GET /users/:userID/lists Returns a user's lists
• POST /users/:userID/albums Adds an album to a user's listened to collection
• DELETE /users/:userID/albums/:albumID Removes an album from a user's collection

Albums

• GET /albums Returns all albums
• GET /albums/:albumID Returns a single album

Reviews

• GET /reviews Returns all reviews
• GET /reviews/:reviewID Returns a single review
• POST /reviews Creates a new review
• PUT /reviews/:reviewID Updates a review
• DELETE /reviews/:reviewID Deletes a review

Lists

• GET /lists Returns all lists
• GET /lists/:listID Returns a single list
• POST /lists Creates a new list
• PUT /lists/:listID Updates a list
• PATCH /lists/:listID Adds an album to a list
• DELETE /lists/:listID Deletes a list

Comments

• GET /comments Fetches all comments
• GET /comments/:commentID Returns a single comment
• POST /comments Creates a new comment
• PUT /comments/:commentID Updates a comment
• DELETE /comments/:commentID Deletes a comment

Search

• POST /search Queries for an album