API Documentation - maxwelljmckee/scare_bnb GitHub Wiki

Resources:

• Users
• Houses
• Booking
• Reviews

Users

Endpoints for the Users resource:

• Log In POST /api/session
• Sign Up - POST /api/users
• Log Out - DELETE /api/session
• Retrieve Single User - GET /api/user/<id>
• Retrieve all houses owned by user - `GET /api/users//houses

Houses

Endpoints for Houses

• Create a house listing - POST /api/houses
• Retrieve all houses available for booking - GET /api/houses
• Displays profile page for a specified house - GET /api/houses/<id>
• Update a house listing - PUT /api/houses/<id>
• Delete a house listing - DELETE /api/houses/<id>

Bookings

Endpoints for the Bookings resource:

• Create a new booking - POST /api/bookings
• Retrieve all Bookings for specified user - GET /api/users/<id>/bookings
• Update an existing booking - PUT /api/users/<id>/bookings
• Delete a booking - DELETE /api/users/<id>/bookings/<id>

Reviews

Endpoints for Reviews resources:

• Retrieve reviews for a specified house GET /api/houses/<id>/reviews
• Write a review - POST /api/houses/<id>/reviews
• Edit a review - PUT /api/houses/<id>/reviews/<id>
• Delete a review DELETE /api/houses/<id>/reviews/<id>