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": ["author", "topic", "sort_by", "order"],
    "exampleResponse": {
      "articles": [
        {
          "title": "Seafood substitutions are increasing",
          "topic": "cooking",
          "author": "weegembump",
          "body": "Text from the article..",
          "created_at": "2018-05-30T15:59:13.341Z",
          "votes": 0,
          "comment_count": 6
        }
      ]
    }
  },
  "GET /api/articles/:article_id": {
    "description": "serves an article object based on the specified ID",
    "queries": [],
    "exampleResponse": {
      "article": {
        "article_id": 1,
        "title": "Living in the shadow of a great man",
        "topic": "mitch",
        "author": "butter_bridge",
        "body": "I find this existence challenging",
        "created_at": "2020-07-09T20:11:00.000Z",
        "votes": 100,
        "article_img_url": "https://images.pexels.com/photos/158651/news-newsletter-newspaper-information-158651.jpeg?w=700&h=700",
        "comment_count": 11
      }
    }
  },
  "GET /api/articles/:article_id/comments": {
    "description": "serves an array of all comments based on the specified article ID",
    "queries": [],
    "exampleResponse": {
      "comments": [
        {
          "comment_id": 1,
          "body": "Oh, I've got compassion running out of my nose, pal! I'm the Sultan of Sentiment!",
          "article_id": 9,
          "author": "butter_bridge",
          "votes": 16,
          "created_at": "2020-04-06T12:17:00.000Z"
        },
        {
          "comment_id": 17,
          "body": "The owls are not what they seem.",
          "article_id": 9,
          "author": "icellusedkars",
          "votes": 20,
          "created_at": "2020-03-14T17:02:00.000Z"
        }
      ]
    }
  },
  "POST /api/articles/:article_id/comments": {
    "description": "serves an object representing the newly posted comment for the specified article ID",
    "queries": [],
    "exampleResponse": {
      "comment": {
        "comment_id": 19,
        "body": "a comment",
        "article_id": 7,
        "author": "lurker",
        "votes": 0,
        "created_at": "2024-04-17T09:14:58.875Z"
      }
    }
  },
  "PATCH /api/articles/:article_id": {
    "description": "serves an object representing the newly updated article for the specified article ID",
    "queries": [],
    "exampleResponse": {
      "article": {
        "article_id": 1,
        "title": "Living in the shadow of a great man",
        "topic": "mitch",
        "author": "butter_bridge",
        "body": "I find this existence challenging",
        "created_at": "2020-07-09T20:11:00.000Z",
        "votes": 101,
        "article_img_url": "https://images.pexels.com/photos/158651/news-newsletter-newspaper-information-158651.jpeg?w=700&h=700"
      }
    }
  },
  "DELETE /api/comments/:comment_id": {
    "description": "deletes the comment identified by its id",
    "queries": []
  },
  "GET /api/users": {
    "description": "serves an array of all users",
    "queries": [],
    "exampleResponse": {
      "users": [
        {
          "username": "butter_bridge",
          "name": "jonny",
          "avatar_url": "https://www.healthytherapies.com/wp-content/uploads/2016/06/Lime3.jpg"
        },
        {
          "username": "lurker",
          "name": "do_nothing",
          "avatar_url": "https://www.golenbock.com/wp-content/uploads/2015/01/placeholder-user.png"
        }
      ]
    }
  },
  "GET /api/users/:username": {
    "description": "serves a user object based on the specified username",
    "queries": [],
    "exampleResponse": {
      "user": {
        "username": "tickle122",
        "name": "Tom Tickle",
        "avatar_url": "https://vignette.wikia.nocookie.net/mrmen/images/d/d6/Mr-Tickle-9a.png/revision/latest?cb=20180127221953"
        }
    }
  }
}