Skip to content

API Routes

James Jones edited this page Sep 27, 2024 · 1 revision

API Routes

Users

  • Users can view other profiles stashes
    • GET /api/users/:userId/stashes
  • Users can view other profiles posts
    • GET /api/users/:userId/images
  • Users can view other profiles favorites
    • GET /api/users/:userId/favorites

Images

  • User can view images on site
    • GET api/images
  • User can view individual images with details/descriptions
    • GET api/images/:imageId
  • User can view another users and their own posted images
  • GET api/:userId/images
  • User can post an image with details.description
    • POST api/images/new
  • User can update their own image details
    • PUT api/images/:imageId
  • Users can delete their own images –FROM DB
    • DELETE api/images/:imageId

Stashes

  • Users can view all stashes of any user including their own
    • GET api/users/:userId/stashes
  • Users can view a specific stash
    • GET api/stashes/:stashId
  • Users can post any image to a stash they own
    • POST api/images/:imageId/stashes/:stashName
  • Users can create a new stash to store image posts
    • POST api/stashes
  • Users can update their own stashes
    • PUT api/stashes/:stashId
  • Users can delete their own stashes
    • DELETE api/stashes/:stashId

Comments

  • User can post new comment on image
    • POST api/images/:imageId/new_comment
  • Users can delete their own comments
    • DELETE api/comments/:commentId

Favorites

  • Users can view all other users and their own saved Favorites

    • GET api/users/:userId/favorites
  • Users can assign images to their Favorites List

    • POST api/images/:imageId/favorite
  • Users can delete images posts from their Favorites List

    • DELETE api/favorites/:favoriteId

Labels

  • User can alter the labels associated to their posts
    • PUT api/images/:imageId

Search

  • Users can search for images by label
    • GET api/images/:labelId

Clone this wiki locally