{"endPoints":{"GET /api":{"description":"serves up a json representation of all the available endpoints of the api","queries":[],"body":null,"exampleResponse":{"GET /api":{},"GET /api/topics":{},"GET /api/articles":{}}},"GET /api/topics":{"description":"serves an array of all topics","queries":[],"body":null,"exampleResponse":{"topics":[{"slug":"football","description":"Footie!"}]}},"GET /api/articles":{"description":"serves an array of all articles","queries":["author","topic","sort_by","order"],"body":null,"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,"article_img_url":"https://images.pexels.com/photos/158651/news-newsletter-newspaper-information-158651.jpeg?w=700&h=700"}]}},"GET /api/articles/:article_id":{"description":"serves a json with the article with the request article_id","queries":[],"body":null,"exampleResponse":{"topics":[{"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":3}]}},"PATCH /api/articles/:article_id":{"description":"patch an article on the specified article_id","queries":[],"body":"{ inc_votes: 100 }","exampleResponse":{"topics":[{"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":"serves a json with the comments for the requested article_id","queries":[],"body":null,"exampleResponse":{"comments":[{"comment_id":125,"body":"Quo voluptate quia commodi illum aliquam quibusdam et quia consequatur. Omnis eligendi consequatur est fugit est. Adipisci incidunt occaecati.","article_id":15,"author":"jessjelly","votes":2,"created_at":"2020-11-05T12:06:00.000Z"},{"comment_id":30,"body":"Et et esse magni qui minus quia adipisci dignissimos. Rerum ab sit voluptatum sequi aspernatur et.","article_id":15,"author":"jessjelly","votes":14,"created_at":"2020-08-25T22:10:00.000Z"}]}},"POST /api/articles/:article_id/comments":{"description":"post a comment on the specified article_id","queries":[],"body":{"username":"icellusedkars","body":"This is a new comment."},"exampleResponse":{"comment":{"comment_id":125,"body":"This is a new comment.","article_id":15,"author":"icellusedkars","votes":0,"created_at":"2023-11-05T12:06:00.000Z"}}},"PATCH /api/comments/:comment_id":{"description":"patch a comment on the specified comment_id","queries":[],"body":{"inc_votes":1},"exampleResponse":{"comment":{"comment_id":125,"body":"Quo voluptate quia commodi illum aliquam quibusdam et quia consequatur. Omnis eligendi consequatur est fugit est. Adipisci incidunt occaecati.","article_id":15,"author":"jessjelly","votes":2,"created_at":"2020-11-05T12:06:00.000Z"}}},"DELETE /api/comments/:comment_id":{"description":"delete a comment by it's id","queries":[],"body":null,"exampleResponse":null},"GET /api/users":{"description":"serves all the users","queries":[],"body":null,"exampleResponse":[{"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"}]}}}