endpoints.json

{
  "GET /api": {
    "description": "serves up a json representation of all the available endpoints of the api"
  },
  "GET /api/topics": {
    "description": "serves an array of all topics",
    "queries": [],
    "exampleResponse": {
      "topics": [{ "slug": "football", "description": "Footie!" }]
    }
  },
  "GET /api/articles": {
    "description": "serves an array of all articles",
    "queries": ["topic", "sort_by", "order"],
    "exampleResponse": {
      "articles": [
        {
          "article_id": 7,
          "author": "weegembump",
          "title": "Seafood substitutions are increasing",
          "topic": "cooking",
          "created_at": "2018-05-30T15:59:13.341Z",
          "votes": 0,
          "article_img_url": "https://images.example.com/123.jpeg",
          "comment_count": 6
        }
      ]
    }
  },
  "GET /api/articles/:article_id": {
    "description": "responds with the article with specified id (if it exists)",
    "queries": [],
    "exampleResponse": {
      "article": [
        {
          "article_id": 3,
          "title": "Eight pug gifs that remind me of mitch",
          "topic": "mitch",
          "author": "icellusedkars",
          "body": "some gifs",
          "created_at": "2020-11-03T09:12:00.000Z",
          "votes": 0,
          "article_img_url": "https://images.pexels.com/photos/158651/news-newsletter-newspaper-information-158651.jpeg?w=700&h=700",
          "comment_count": 2
        }
      ]
    }
  },
  "PATCH /api/articles/:article_id": {
    "description": "updates (increments/decrements) the number of votes on the specified article by the given number and responds with the updated article",
    "queries": [],
    "requestBody": {
      "requiredFields": ["inc_votes"],
      "optionalFields": [],
      "exampleRequestBody": {
        "inc_votes": 100
      }
    },
    "exampleResponse": {
      "article": [
        {
          "article_id": 3,
          "title": "Eight pug gifs that remind me of mitch",
          "topic": "mitch",
          "author": "icellusedkars",
          "body": "some gifs",
          "created_at": "2020-11-03T09:12:00.000Z",
          "votes": 100,
          "article_img_url": "https://images.pexels.com/photos/158651/news-newsletter-newspaper-information-158651.jpeg?w=700&h=700"
        }
      ]
    }
  },
  "GET /api/articles/:article_id/comments": {
    "description": "responds with an array of the comments on the specified article (if it exists)",
    "queries": [],
    "exampleResponse": {
      "comments": [
        {
          "comment_id": 7,
          "body": "Lobster pot",
          "article_id": 1,
          "author": "icellusedkars",
          "votes": 0,
          "created_at": "2020-05-15T21:19:00.000Z"
        }
      ]
    }
  },
  "POST /api/articles/:article_id/comments": {
    "description": "posts a new comment at the specified article (if it exists) and responds with the posted comment",
    "queries": [],
    "requestBody": {
      "requiredFields": ["username", "body"],
      "optionalFields": [],
      "exampleRequestBody": {
        "username": "icellusedkars",
        "body": "Lobster pot"
      }
    },
    "exampleResponse": {
      "comment": [
        {
          "comment_id": 8,
          "body": "Lobster pot",
          "article_id": 1,
          "author": "icellusedkars",
          "votes": 0,
          "created_at": "2020-05-15T21:19:00.000Z"
        }
      ]
    }
  },
  "PATCH /api/comments/:comment_id": {
    "description": "updates (increments/decrements) the number of votes on the specified comment by the given number and responds with the updated comment",
    "queries": [],
    "requestBody": {
      "requiredFields": ["inc_votes"],
      "optionalFields": [],
      "exampleRequestBody": {
        "inc_votes": 100
      }
    },
    "exampleResponse": {
      "comment": [
        {
          "comment_id": 8,
          "body": "Lobster pot",
          "article_id": 1,
          "author": "icellusedkars",
          "votes": 100,
          "created_at": "2020-05-15T21:19:00.000Z"
        }
      ]
    }
  },
  "DELETE /api/comments/:comment_id": {
    "description": "deletes the specified comment (if it exists) and sends no body back",
    "queries": [],
    "exampleResponse": {}
  },
  "GET /api/users": {
    "description": "serves an array of all users",
    "queries": [],
    "exampleResponse": {
      "users": [
        {
          "username": "icellusedkars",
          "name": "sam",
          "avatar_url": "https://avatars2.githubusercontent.com/u/24604688?s=460&v=4"
        }
      ]
    }
  },
  "GET /api/users/:username": {
    "description": "responds with the user with the username given (if it exists)",
    "queries": [],
    "exampleResponse": {
      "user": [
        {
          "username": "icellusedkars",
          "name": "sam",
          "avatar_url": "https://avatars2.githubusercontent.com/u/24604688?s=460&v=4"
        }
      ]
    }
  }
}