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": "Does Mitch predate civilisation?",
          "author": "icellusedkars",
          "article_id": 8,
          "topic": "mitch",
          "created_at": "2020-04-17T01:08: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": "0"
        },
        {
          "title": "Am I a cat?",
          "author": "icellusedkars",
          "article_id": 11,
          "topic": "mitch",
          "created_at": "2020-01-15T22:21: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": "0"
        }
      ]
    }
  },
  "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": "icellusedkars",
          "name": "sam",
          "avatar_url": "https://avatars2.githubusercontent.com/u/24604688?s=460&v=4"
        },
        {
          "username": "rogersop",
          "name": "'paul'",
          "avatar_url": "'https://avatars2.githubusercontent.com/u/24394918?s=400&v=4'"
        },
        {
          "username": "lurker",
          "name": "do_nothing",
          "avatar_url": "https://www.golenbock.com/wp-content/uploads/2015/01/placeholder-user.png"
        }
      ]
    }
  },
  "GET /api/articles/:article_id": {
    "description": "serves an article object",
    "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"
      }
    }
  },
  "GET /api/articles/:article_id/comments": {
    "description": "serves an array of comments",
    "queries": [],
    "exampleResponse": {
      "comments": [
        {
          "comment_id": 144,
          "votes": 19,
          "created_at": "2020-11-23T17:00:00.000Z",
          "author": "grumpy19",
          "body": "Placeat voluptatum consequatur ducimus et eum molestiae impedit eveniet. Recusandae rerum voluptas quia mollitia quam velit iusto. Eum eos similique minima necessitatibus nemo. Iure deleniti omnis enim animi iste delectus et consequuntur.",
          "article_id": 5
        },
        {
          "comment_id": 116,
          "votes": 3,
          "created_at": "2020-09-03T01:06:00.000Z",
          "author": "weegembump",
          "body": "Praesentium dolor doloribus sint. Quisquam molestiae dolorum asperiores animi omnis.",
          "article_id": 5
        },
        {
          "comment_id": 18,
          "votes": 6,
          "created_at": "2020-08-15T17:11:00.000Z",
          "author": "jessjelly",
          "body": "Dicta aut quo unde cupiditate dolorum. Voluptas mollitia exercitationem vel porro dolor. Ea autem est pariatur.",
          "article_id": 5
        }
      ]
    }
  },
  "POST /api/articles/:article_id/comments": {
    "description": "accepts a request body with username and body properties, and responds with posted comment",
    "queries": [],
    "exampleRequest": {
      "username": "butter_bridge",
      "body": "Mitch should definitely grow a handsome Dallas on his face, it would look glorious."
    },
    "exampleResponse": {
      "comments": {
        "comment_id": 19,
        "votes": 0,
        "created_at": "2020-11-23T17:00:00.000Z",
        "author": "butter_bridge",
        "body": "Mitch should definitely grow a handsome Dallas on his face, it would look glorious.",
        "article_id": 12
      }
    }
  },
  "PATCH /api/articles/:article_id": {
    "description": "accepts a request body with an object in the form { inc_votes: newVote } newVote will indicate how much the votes property in the database should be updated by",
    "queries": [],
    "exampleRequest": {
      "inc_votes": -10
    },
    "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": 90,
        "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": "respond with a status 204 and no content, deletes the given comment by comment_id",
    "queries": [],
    "exampleResponse": {}
  }
}