JSON Contracts - Githubissues

tvaroglu / spot_me_backend

SpotMe is a 10-day, 6 person project, during Mod 3 of 4 for Turing School's Back End Engineering Program.

https://spotme-app.herokuapp.com

4 stars 1 forks source link

JSON Contracts #33

Closed tvaroglu closed 3 years ago

tvaroglu commented 3 years ago

Card to track JSON contracts for all endpoints (request / response, required params, etc.). Table from ReadMe links to a /docs dir that will store details for each resource.

The following endpoint documentation will need to be updated in the README and associated doc file:

Users

[x] GET | /api/v1/users/find
[X] GET | /api/v1/users/:id
[X] PATCH | /api/v1/users/:id
[X] POST | /api/v1/users

Friendships

[X] GET | /api/v1/users/:user_id/friendships
[X] POST | /api/v1/users/:user_id/friendships
[x] DELETE | /api/v1/users/:user_id/friendships/:id

Events

[x] GET | /api/v1/users/:user_id/events
[x] POST | /api/v1/users/:user_id/gym_memberships/:gym_membership_id/events
[x] DELETE | /api/v1/users/:user_id/gym_memberships/:gym_membership_id/events/:id

Gym Members

[x] GET | /api/v1/users/:user_id/gym_members
[X] GET | /api/v1/users/:user_id/gym_memberships
[X] POST | /api/v1/users/:user_id/gym_memberships
[X] DELETE | /api/v1/users/:user_id/gym_memberships/:id

Gym Search

[x] GET | /api/v1/gym_search
[x] GET | /api/v1/gym_search/:id