AirBnB Throwback

Database Schema Design

API Documentation

USER AUTHENTICATION/AUTHORIZATION

All endpoints that require authentication

All endpoints that require a current user to be logged in.

• Request: endpoints that require authentication
• Error Response: Require authentication

  • Status Code: 401

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "message": "Authentication required",
      "statusCode": 401
    }

All endpoints that require proper authorization

All endpoints that require authentication and the current user does not have the correct role(s) or permission(s).

• Request: endpoints that require proper authorization
• Error Response: Require proper authorization

  • Status Code: 403

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "message": "Forbidden",
      "statusCode": 403
    }

Get the Current User

Returns the information about the current user that is logged in.

• Require Authentication: true

• Request

  • Method: GET
  • URL: /users/currentuser
  • Body: none

• Successful Response when there is a logged in user

  • Status Code: 200

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "user": {
        "id": 1,
        "firstName": "John",
        "lastName": "Smith",
        "email": "john.smith@gmail.com",
        "username": "JohnSmith"
      }
    }

• Successful Response when there is no logged in user

  • Status Code: 200

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "user": null
    }

Log In a User

Logs in a current user with valid credentials and returns the current user's information.

• Require Authentication: false

• Request

  • Method: POST

  • URL: /users/login

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "credential": "john.smith@gmail.com",
      "password": "secret password"
    }

• Successful Response

  • Status Code: 200

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "user": {
        "id": 1,
        "firstName": "John",
        "lastName": "Smith",
        "email": "john.smith@gmail.com",
        "username": "JohnSmith",
        "token": ""
      }
    }

• Error Response: Invalid credentials

  • Status Code: 401

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "message": "Invalid credentials",
      "statusCode": 401
    }

• Error response: Body validation errors

  • Status Code: 400

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "message": "Validation error",
      "statusCode": 400,
      "errors": [
        "Email or username is required",
        "Password is required"
      ]
    }

Sign Up a User

Creates a new user, logs them in as the current user, and returns the current user's information.

• Require Authentication: false

• Request

  • Method: POST

  • URL: /users

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "firstName": "John",
      "lastName": "Smith",
      "email": "john.smith@gmail.com",
      "username": "JohnSmith",
      "password": "secret password"
    }

• Successful Response

  • Status Code: 200

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "user": {
        "id": 1,
        "firstName": "John",
        "lastName": "Smith",
        "email": "john.smith@gmail.com",
        "username": "JohnSmith",
        "token": ""
      }
    }

• Error response: User already exists with the specified email

  • Status Code: 403

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "message": "User already exists",
      "statusCode": 403,
      "errors": [
        "User with that email already exists"
      ]
    }

• Error response: User already exists with the specified username

  • Status Code: 403

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "message": "User already exists",
      "statusCode": 403,
      "errors": [
        "User with that username already exists"
      ]
    }

• Error response: Body validation errors

  • Status Code: 400

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "message": "Validation error",
      "statusCode": 400,
      "errors": [
        "Invalid email",
        "Username is required",
        "First Name is required",
        "Last Name is required"
      ]
    }

SPOTS

Get all Spots

Returns all the spots.

• Require Authentication: false

• Request

  • Method: GET
  • URL: /spots
  • Body: none

• Successful Response

  • Status Code: 200

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "Spots": [
        {
          "id": 1,
          "ownerId": 1,
          "address": "123 Disney Lane",
          "city": "San Francisco",
          "state": "California",
          "country": "United States of America",
          "lat": 37.7645358,
          "lng": -122.4730327,
          "name": "App Academy",
          "description": "Place where web developers are created",
          "price": 123,
          "createdAt": "2021-11-19 20:39:36",
          "updatedAt": "2021-11-19 20:39:36",
          "avgRating": 4.5,
          "previewImage": "image url"
        }
      ]
    }

Get all Spots owned by the Current User

Returns all the spots owned (created) by the current user.

• Require Authentication: true

• Request

  • Method: GET
  • URL: /spots/currentuser
  • Body: none

• Successful Response

  • Status Code: 200

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "Spots": [
        {
          "id": 1,
          "ownerId": 1,
          "address": "123 Disney Lane",
          "city": "San Francisco",
          "state": "California",
          "country": "United States of America",
          "lat": 37.7645358,
          "lng": -122.4730327,
          "name": "App Academy",
          "description": "Place where web developers are created",
          "price": 123,
          "createdAt": "2021-11-19 20:39:36",
          "updatedAt": "2021-11-19 20:39:36",
          "avgRating": 4.5,
          "previewImage": "image url"
        }
      ]
    }

Get details of a Spot from an id

Returns the details of a spot specified by its id.

• Require Authentication: false

• Request

  • Method: GET
  • URL: /spots/:id
  • Body: none

• Successful Response

  • Status Code: 200

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "id": 1,
      "ownerId": 1,
      "address": "123 Disney Lane",
      "city": "San Francisco",
      "state": "California",
      "country": "United States of America",
      "lat": 37.7645358,
      "lng": -122.4730327,
      "name": "App Academy",
      "description": "Place where web developers are created",
      "price": 123,
      "createdAt": "2021-11-19 20:39:36",
      "updatedAt": "2021-11-19 20:39:36" ,
      "numReviews": 5,
      "avgStarRating": 4.5,
      "SpotImages": [
        {
          "id": 1,
          "url": "image url",
          "preview": true
        },
        {
          "id": 2,
          "url": "image url",
          "preview": false
        }
      ],
      "Owner": {
        "id": 1,
        "firstName": "John",
        "lastName": "Smith"
      }
    }

• Error response: Couldn't find a Spot with the specified id

  • Status Code: 404

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "message": "Spot couldn't be found",
      "statusCode": 404
    }

Create a Spot

Creates and returns a new spot.

• Require Authentication: true

• Request

  • Method: POST

  • URL: /spots

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "address": "123 Disney Lane",
      "city": "San Francisco",
      "state": "California",
      "country": "United States of America",
      "lat": 37.7645358,
      "lng": -122.4730327,
      "name": "App Academy",
      "description": "Place where web developers are created",
      "price": 123
    }

• Successful Response

  • Status Code: 201

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "id": 1,
      "ownerId": 1,
      "address": "123 Disney Lane",
      "city": "San Francisco",
      "state": "California",
      "country": "United States of America",
      "lat": 37.7645358,
      "lng": -122.4730327,
      "name": "App Academy",
      "description": "Place where web developers are created",
      "price": 123,
      "createdAt": "2021-11-19 20:39:36",
      "updatedAt": "2021-11-19 20:39:36"
    }

• Error Response: Body validation error

  • Status Code: 400

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "message": "Validation Error",
      "statusCode": 400,
      "errors": [
        "Street address is required",
        "City is required",
        "State is required",
        "Country is required",
        "Latitude is not valid",
        "Longitude is not valid",
        "Name must be less than 50 characters",
        "Description is required",
        "Price per day is required"
      ]
    }

Add an Image to a Spot based on the Spot's id

Create and return a new image for a spot specified by id.

• Require Authentication: true

• Require proper authorization: Spot must belong to the current user

• Request

  • Method: POST

  • URL: /spots/:id/images

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "url": "image url",
      "preview": true
    }

• Successful Response

  • Status Code: 200

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "id": 1,
      "url": "image url",
      "preview": true
    }

• Error response: Couldn't find a Spot with the specified id

  • Status Code: 404

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "message": "Spot couldn't be found",
      "statusCode": 404
    }

Edit a Spot

Updates and returns an existing spot.

• Require Authentication: true

• Require proper authorization: Spot must belong to the current user

• Request

  • Method: PUT

  • URL: /spots/:id

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "address": "123 Disney Lane",
      "city": "San Francisco",
      "state": "California",
      "country": "United States of America",
      "lat": 37.7645358,
      "lng": -122.4730327,
      "name": "App Academy",
      "description": "Place where web developers are created",
      "price": 123
    }

• Successful Response

  • Status Code: 200

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "id": 1,
      "ownerId": 1,
      "address": "123 Disney Lane",
      "city": "San Francisco",
      "state": "California",
      "country": "United States of America",
      "lat": 37.7645358,
      "lng": -122.4730327,
      "name": "App Academy",
      "description": "Place where web developers are created",
      "price": 123,
      "createdAt": "2021-11-19 20:39:36",
      "updatedAt": "2021-11-20 10:06:40"
    }

• Error Response: Body validation error

  • Status Code: 400

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "message": "Validation Error",
      "statusCode": 400,
      "errors": [
        "Street address is required",
        "City is required",
        "State is required",
        "Country is required",
        "Latitude is not valid",
        "Longitude is not valid",
        "Name must be less than 50 characters",
        "Description is required",
        "Price per day is required"
      ]
    }

• Error response: Couldn't find a Spot with the specified id

  • Status Code: 404

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "message": "Spot couldn't be found",
      "statusCode": 404
    }

Delete a Spot

Deletes an existing spot.

• Require Authentication: true

• Require proper authorization: Spot must belong to the current user

• Request

  • Method: DELETE
  • URL: /spots/:id
  • Body: none

• Successful Response

  • Status Code: 200

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "message": "Successfully deleted",
      "statusCode": 200
    }

• Error response: Couldn't find a Spot with the specified id

  • Status Code: 404

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "message": "Spot couldn't be found",
      "statusCode": 404
    }

REVIEWS

Get all Reviews of the Current User

Returns all the reviews written by the current user.

• Require Authentication: true

• Request

  • Method: GET
  • URL: /users/currentuser/reviews
  • Body: none

• Successful Response

  • Status Code: 200

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "Reviews": [
        {
          "id": 1,
          "userId": 1,
          "spotId": 1,
          "review": "This was an awesome spot!",
          "stars": 5,
          "createdAt": "2021-11-19 20:39:36",
          "updatedAt": "2021-11-19 20:39:36" ,
          "User": {
            "id": 1,
            "firstName": "John",
            "lastName": "Smith"
          },
          "Spot": {
            "id": 1,
            "ownerId": 1,
            "address": "123 Disney Lane",
            "city": "San Francisco",
            "state": "California",
            "country": "United States of America",
            "lat": 37.7645358,
            "lng": -122.4730327,
            "name": "App Academy",
            "price": 123,
            "previewImage": "image url"
          },
          "ReviewImages": [
            {
              "id": 1,
              "url": "image url"
            }
          ]
        }
      ]
    }

Get all Reviews by a Spot's id

Returns all the reviews that belong to a spot specified by id.

• Require Authentication: false

• Request

  • Method: GET
  • URL: /spots/:id/reviews
  • Body: none

• Successful Response

  • Status Code: 200

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "Reviews": [
        {
          "id": 1,
          "userId": 1,
          "spotId": 1,
          "review": "This was an awesome spot!",
          "stars": 5,
          "createdAt": "2021-11-19 20:39:36",
          "updatedAt": "2021-11-19 20:39:36" ,
          "User": {
            "id": 1,
            "firstName": "John",
            "lastName": "Smith"
          },
          "ReviewImages": [
            {
              "id": 1,
              "url": "image url"
            }
          ],
        }
      ]
    }

• Error response: Couldn't find a Spot with the specified id

  • Status Code: 404

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "message": "Spot couldn't be found",
      "statusCode": 404
    }

Create a Review for a Spot based on the Spot's id

Create and return a new review for a spot specified by id.

• Require Authentication: true

• Request

  • Method: POST

  • URL: /spots/:id/reviews

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "review": "This was an awesome spot!",
      "stars": 5,
    }

• Successful Response

  • Status Code: 201

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "id": 1,
      "userId": 1,
      "spotId": 1,
      "review": "This was an awesome spot!",
      "stars": 5,
      "createdAt": "2021-11-19 20:39:36",
      "updatedAt": "2021-11-19 20:39:36"
    }

• Error Response: Body validation errors

  • Status Code: 400

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "message": "Validation error",
      "statusCode": 400,
      "errors": [
        "Review text is required",
        "Stars must be an integer from 1 to 5",
      ]
    }

• Error response: Couldn't find a Spot with the specified id

  • Status Code: 404

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "message": "Spot couldn't be found",
      "statusCode": 404
    }

• Error response: Review from the current user already exists for the Spot

  • Status Code: 403

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "message": "User already has a review for this spot",
      "statusCode": 403
    }

Add an Image to a Review based on the Review's id

Create and return a new image for a review specified by id.

• Require Authentication: true

• Require proper authorization: Review must belong to the current user

• Request

  • Method: POST

  • URL: /reviews/:id/images

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "url": "image url"
    }

• Successful Response

  • Status Code: 200

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "id": 1,
      "url": "image url"
    }

• Error response: Couldn't find a Review with the specified id

  • Status Code: 404

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "message": "Review couldn't be found",
      "statusCode": 404
    }

• Error response: Cannot add any more images because there is a maximum of 10 images per resource

  • Status Code: 403

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "message": "Maximum number of images for this resource was reached",
      "statusCode": 403
    }

Edit a Review

Update and return an existing review.

• Require Authentication: true

• Require proper authorization: Review must belong to the current user

• Request

  • Method: PUT

  • URL: /reviews/:id

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "review": "This was an awesome spot!",
      "stars": 5,
    }

• Successful Response

  • Status Code: 200

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "id": 1,
      "userId": 1,
      "spotId": 1,
      "review": "This was an awesome spot!",
      "stars": 5,
      "createdAt": "2021-11-19 20:39:36",
      "updatedAt": "2021-11-20 10:06:40"
    }

• Error Response: Body validation errors

  • Status Code: 400

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "message": "Validation error",
      "statusCode": 400,
      "errors": [
        "Review text is required",
        "Stars must be an integer from 1 to 5",
      ]
    }

• Error response: Couldn't find a Review with the specified id

  • Status Code: 404

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "message": "Review couldn't be found",
      "statusCode": 404
    }

Delete a Review

Delete an existing review.

• Require Authentication: true

• Require proper authorization: Review must belong to the current user

• Request

  • Method: DELETE
  • URL: /reviews/:id
  • Body: none

• Successful Response

  • Status Code: 200

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "message": "Successfully deleted",
      "statusCode": 200
    }

• Error response: Couldn't find a Review with the specified id

  • Status Code: 404

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "message": "Review couldn't be found",
      "statusCode": 404
    }

BOOKINGS

Get all of the Current User's Bookings

Return all the bookings that the current user has made.

• Require Authentication: true

• Request

  • Method: GET
  • URL: /users/currentuser/bookings
  • Body: none

• Successful Response

  • Status Code: 200

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "Bookings": [
        {
          "id": 1,
          "spotId": 1,
          "Spot": {
            "id": 1,
            "ownerId": 1,
            "address": "123 Disney Lane",
            "city": "San Francisco",
            "state": "California",
            "country": "United States of America",
            "lat": 37.7645358,
            "lng": -122.4730327,
            "name": "App Academy",
            "price": 123,
            "previewImage": "image url"
          },
          "userId": 2,
          "startDate": "2021-11-19",
          "endDate": "2021-11-20",
          "createdAt": "2021-11-19 20:39:36",
          "updatedAt": "2021-11-19 20:39:36"
        }
      ]
    }

Get all Bookings for a Spot based on the Spot's id

Return all the bookings for a spot specified by id.

• Require Authentication: true

• Request

  • Method: GET
  • URL: /spots/:id/bookings
  • Body: none

• Successful Response: If you ARE NOT the owner of the spot.

  • Status Code: 200

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "Bookings": [
        {
          "spotId": 1,
          "startDate": "2021-11-19",
          "endDate": "2021-11-20"
        }
      ]
    }

• Successful Response: If you ARE the owner of the spot.

  • Status Code: 200

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "Bookings": [
        {
          "User": {
            "id": 2,
            "firstName": "John",
            "lastName": "Smith"
          },
          "id": 1,
          "spotId": 1,
          "userId": 2,
          "startDate": "2021-11-19",
          "endDate": "2021-11-20",
          "createdAt": "2021-11-19 20:39:36",
          "updatedAt": "2021-11-19 20:39:36"
        }
      ]
    }

• Error response: Couldn't find a Spot with the specified id

  • Status Code: 404

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "message": "Spot couldn't be found",
      "statusCode": 404
    }

Create a Booking from a Spot based on the Spot's id

Create and return a new booking from a spot specified by id.

• Require Authentication: true

• Require proper authorization: Spot must NOT belong to the current user

• Request

  • Method: POST

  • URL: /spots/:id/bookings

  • Body:

    {
      "startDate": "2021-11-19",
      "endDate": "2021-11-20"
    }

• Successful Response

  • Status Code: 200

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "id": 1,
      "spotId": 1,
      "userId": 2,
      "startDate": "2021-11-19",
      "endDate": "2021-11-20",
      "createdAt": "2021-11-19 20:39:36",
      "updatedAt": "2021-11-19 20:39:36"
    }

• Error response: Body validation errors

  • Status Code: 400

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "message": "Validation error",
      "statusCode": 400,
      "errors": [
        "endDate cannot be on or before startDate"
      ]
    }

• Error response: Couldn't find a Spot with the specified id

  • Status Code: 404

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "message": "Spot couldn't be found",
      "statusCode": 404
    }

• Error response: Booking conflict

  • Status Code: 403

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "message": "Sorry, this spot is already booked for the specified dates",
      "statusCode": 403,
      "errors": [
        "Start date conflicts with an existing booking",
        "End date conflicts with an existing booking"
      ]
    }
    
    

Edit a Booking

Update and return an existing booking.

• Require Authentication: true

• Require proper authorization: Booking must belong to the current user

• Request

  • Method: PUT

  • URL: /bookings/:id

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "startDate": "2021-11-19",
      "endDate": "2021-11-20"
    }

• Successful Response

  • Status Code: 200

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "id": 1,
      "spotId": 1,
      "userId": 2,
      "startDate": "2021-11-19",
      "endDate": "2021-11-20",
      "createdAt": "2021-11-19 20:39:36",
      "updatedAt": "2021-11-20 10:06:40"
    }

• Error response: Body validation errors

  • Status Code: 400

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "message": "Validation error",
      "statusCode": 400,
      "errors": [
        "endDate cannot come before startDate"
      ]
    }

• Error response: Couldn't find a Booking with the specified id

  • Status Code: 404

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "message": "Booking couldn't be found",
      "statusCode": 404
    }

• Error response: Can't edit a booking that's past the end date

  • Status Code: 403

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "message": "Past bookings can't be modified",
      "statusCode": 403
    }

• Error response: Booking conflict

  • Status Code: 403

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "message": "Sorry, this spot is already booked for the specified dates",
      "statusCode": 403,
      "errors": [
        "Start date conflicts with an existing booking",
        "End date conflicts with an existing booking"
      ]
    }

Delete a Booking

Delete an existing booking.

• Require Authentication: true

• Require proper authorization: Booking must belong to the current user or the Spot must belong to the current user

• Request

  • Method: DELETE
  • URL: /bookings/:id
  • Body: none

• Successful Response

  • Status Code: 200

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "message": "Successfully deleted",
      "statusCode": 200
    }

• Error response: Couldn't find a Booking with the specified id

  • Status Code: 404

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "message": "Booking couldn't be found",
      "statusCode": 404
    }

• Error response: Bookings that have been started can't be deleted

  • Status Code: 403

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "message": "Bookings that have been started can't be deleted",
      "statusCode": 403
    }

IMAGES

Delete a Spot Image

Delete an existing image for a Spot.

• Require Authentication: true

• Require proper authorization: Spot must belong to the current user

• Request

  • Method: DELETE
  • URL: /spots/:id/images/:imageid
  • Body: none

• Successful Response

  • Status Code: 200

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "message": "Successfully deleted",
      "statusCode": 200
    }

• Error response: Couldn't find a Spot Image with the specified id

  • Status Code: 404

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "message": "Spot Image couldn't be found",
      "statusCode": 404
    }

Delete a Review Image

Delete an existing image for a Review.

• Require Authentication: true

• Require proper authorization: Review must belong to the current user

• Request

  • Method: DELETE
  • URL: /reviews/:id/images/:imageid
  • Body: none

• Successful Response

  • Status Code: 200

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "message": "Successfully deleted",
      "statusCode": 200
    }

• Error response: Couldn't find a Review Image with the specified id

  • Status Code: 404

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "message": "Review Image couldn't be found",
      "statusCode": 404
    }

Add Query Filters to Get All Spots

Return spots filtered by query parameters.

• Require Authentication: false

• Request

  • Method: GET
  • URL: /spots
  • Query Parameters
    • page: integer, minimum: 0, maximum: 10, default: 0
    • size: integer, minimum: 0, maximum: 20, default: 20
    • minLat: decimal, optional
    • maxLat: decimal, optional
    • minLng: decimal, optional
    • maxLng: decimal, optional
    • minPrice: decimal, optional, minimum: 0
    • maxPrice: decimal, optional, minimum: 0
  • Body: none

• Successful Response

  • Status Code: 200

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "Spots":[
        {
          "id": 1,
          "ownerId": 1,
          "address": "123 Disney Lane",
          "city": "San Francisco",
          "state": "California",
          "country": "United States of America",
          "lat": 37.7645358,
          "lng": -122.4730327,
          "name": "App Academy",
          "description": "Place where web developers are created",
          "price": 123,
          "createdAt": "2021-11-19 20:39:36",
          "updatedAt": "2021-11-19 20:39:36",
          "previewImage": "image url"
        }
      ],
      "page": 2,
      "size": 25
    }

• Error Response: Query parameter validation errors

  • Status Code: 400

  • Headers:

    • Content-Type: application/json

  • Body:

    {
      "message": "Validation Error",
      "statusCode": 400,
      "errors": [
        "Page must be greater than or equal to 0",
        "Size must be greater than or equal to 0",
        "Maximum latitude is invalid",
        "Minimum latitude is invalid",
        "Maximum longitude is invalid",
        "Minimum longitude is invalid",
        "Maximum price must be greater than or equal to 0",
        "Minimum price must be greater than or equal to 0"
      ]
    }