endpoints.json

{
  "GET /api": {
    "description": "serves up a json representation of all the available endpoints of the api",
    "queries": [],
    "exampleRequest": {},
    "exampleResponse": {
      "GET /api/users": {
        "description": "serves an array of all users",
        "queries": [],
        "exampleResponse": {
          "users": [
            {
              "_id": "6593ea41c9a9cf457f28a326",
              "username": "Hello",
              "firstname": "jamie",
              "lastname": "harper",
              "email": "a@a.com"
            },
            {
              "_id": "6593ea41c9a9cf457f28a327",
              "username": "ASKJHD",
              "firstname": "james",
              "lastname": "harper",
              "email": "b@a.com"
            }
          ]
        }
      }
    }
  },
  "GET /api/users": {
    "description": "serves an array of all users",
    "queries": [],
    "exampleResponse": {
      "users": [
        {
          "_id": "6593ea41c9a9cf457f28a326",
          "username": "Hello",
          "firstname": "jamie",
          "lastname": "harper",
          "email": "a@a.com"
        },
        {
          "_id": "6593ea41c9a9cf457f28a327",
          "username": "ASKJHD",
          "firstname": "james",
          "lastname": "harper",
          "email": "b@a.com"
        }
      ]
    }
  },
  "GET /api/users/:username": {
    "description": "serves a user object by username provided",
    "queries": [],
    "exampleResponse": {
      "user": {
        "_id": "6593ed200e9bf4ea20950890",
        "username": "Hello",
        "firstname": "jamie",
        "lastname": "harper",
        "email": "a@a.com"
      }
    }
  },
  "GET /api/users/:username/quotes": {
    "description": "serves an array of quotes for a given username",
    "queries": [],
    "exampleResponse": {
      "quotes": [
        {
          "_id": "6594329ec2dff3a32d33fe28",
          "quoteText": "a random quote",
          "quoteAuthor": "a quote author",
          "quoteOrigin": "fiction book",
          "quoteLocation": "[10,10]",
          "quoteImage": "apicturelink.jpg",
          "quoteIsPrivate": true,
          "quoteUser": "Hello",
          "quoteCategory": "Book"
        },
        {
          "_id": "6594329ec2dff3a32d33fe29",
          "quoteText": "a random quotequotequotequote",
          "quoteAuthor": "a quote author",
          "quoteOrigin": "fiction book",
          "quoteLocation": "[10,10]",
          "quoteImage": "apicturelink.jpg",
          "quoteIsPrivate": true,
          "quoteUser": "Hello",
          "quoteCategory": "Book"
        }
      ]
    }
  },

  "GET /api/quotes": {
    "description": "serves an array of all quotes",
    "queries": [],
    "exampleResponse": {
      "quotes": [
        {
          "_id": "6594329ec2dff3a32d33fe28",
          "quoteText": "a random quote",
          "quoteAuthor": "a quote author",
          "quoteOrigin": "fiction book",
          "quoteLocation": "[10,10]",
          "quoteImage": "apicturelink.jpg",
          "quoteIsPrivate": true,
          "quoteUser": "Hello",
          "quoteCategory": "Book"
        },
        {
          "_id": "6594329ec2dff3a32d33fe29",
          "quoteText": "a random quotequotequotequote",
          "quoteAuthor": "a quote author",
          "quoteOrigin": "fiction book",
          "quoteLocation": "[10,10]",
          "quoteImage": "apicturelink.jpg",
          "quoteIsPrivate": true,
          "quoteUser": "Hello",
          "quoteCategory": "Book"
        }
      ]
    }
  },
  "GET /api/quotes/:quote_id": {
    "description": "serves a quote object by quote ID provided",
    "queries": [],
    "exampleResponse": {
      "quote": {
        "_id": "6594329ec2dff3a32d33fe28",
        "quoteText": "a random quote",
        "quoteAuthor": "a quote author",
        "quoteOrigin": "fiction book",
        "quoteLocation": "[10,10]",
        "quoteImage": "apicturelink.jpg",
        "quoteIsPrivate": true,
        "quoteUser": "Hello",
        "quoteCategory": "Book"
      }
    }
  },
  "POST /api/users": {
    "description": "returns an object of a user object when sent a username,firstname,lastname,email",
    "queries": [],
    "exampleRequest": {
      "username": "testuser",
      "firstname": "test",
      "lastname": "user",
      "email": "test@user.com"
    },
    "exampleResponse": {
      "user": {
        "_id": "659584f5b509ec9b4f604e62",
        "username": "testuser",
        "firstname": "test",
        "lastname": "user",
        "email": "test@user.com"
      }
    }
  },
  "PATCH /api/users": {
    "description": "returns an object of a user object given keys to update",
    "queries": [],
    "exampleRequest": {
      "firstname": "newName",
      "lastname": "newLastName"
    },
    "exampleResponse": {
      "user": {
        "_id": "659584f5b509ec9b4f604e62",
        "username": "Hello",
        "firstname": "newName",
        "lastname": "newLastName",
        "email": "a@a.com"
      }
    }
  },
  "DELETE /api/users/:username": {
    "description": "Deletes a user when given a username",
    "queries": [],
    "exampleResponse": {}
  }
}