{"GET /api":{"description":"responds with a json representation of all the available endpoints of the api"},"GET /api/topics":{"description":"responds with an array of all topics","queries":[],"exampleResponse":{"topics":[{"slug":"football","description":"Footie!"}]}},"GET /api/articles":{"description":"responds with an array of all articles. Valid sort_by queries: created_at (default), comment_count or votes. Valid group_by queries: asc, desc (default). Topic queries filter the articles by a specified topic.","queries":["author","topic","sort_by","order_by"],"sort_by_values":["article_id","title","topic","author","votes","article_img_url","comment_count"],"order_by_values":["asc","desc (default)"],"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":"responds with an array of all the articles which have the specified article_id","queries":[],"exampleResponse":{"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":"responds with an array of comments for the specified article_id","queries":[],"exampleResponse":{"comments":[{"comment_id":5,"body":"I hate streaming noses","article_id":1,"author":"icellusedkars","votes":0,"created_at":"2020-11-03T21:00:00.000Z"}]}},"GET /api/users":{"description":"responds with 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"}]}},"POST /api/articles/:article_id/comments":{"description":"adds a comment to the article, and responds with the newly created comment","queries":[],"exampleRequest":{"username":"icellusedkars","body":"I can't think of a good comment"},"exampleResponse":{"comment_id":19,"body":"I can't think of a good comment","article_id":1,"author":"icellusedkars","votes":0,"created_at":"2024-01-18T13:09:34.577Z"}},"PATCH /api/articles/:article_id":{"description":"Updates the votes of the article with the specified article_id, and responds with the updated article votes. The body of the request should include an inc_votes key with a positive value to increase the number of votes, or a negative value to decrease the number.","queries":[],"exampleRequest":{"inc_votes":-10},"exampleResponse":{"title":"Living in the shadow of a great man","topic":"mitch","author":"butter_bridge","body":"I find this existence challenging","created_at":1594329060000,"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":"Deletes the comment with the specified comment_id, and responds with status code of 204 and no content","queries":[],"exampleResponse":{}},"PATCH /api/comments/:comment_id":{"description":"Updates the votes for either negative or positive values of the comment with the specified comment_id, and responds with the updated comment","queries":[],"exampleRequest":{"inc_votes":1},"exampleResponse":{"comment_id":2,"body":"The beautiful thing about treasure is that it exists. Got to find out what kind of sheets these are; not cotton, not rayon, silky.","votes":15,"author":"butter_bridge","article_id":1,"created_at":1604113380000}},"POST /api/articles":{"description":"responds with the newly added article post","queries":[],"exampleRequest":{"author":"grumpy19","title":"Article Test Title","body":"Article test body","topic":"coding","article_img_url":"https://images.pexels.com/photos/158651/news-newsletter-newspaper-information-158651.jpeg?w=700&h=700"},"exampleResponse":{"article":{"article_id":38,"title":"Article Test Title","topic":"coding","body":"Article test body","author":"grumpy19","created_at":"2024-04-27T17:52:29.349Z","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/comments/:username":{"description":"responds with an array of all comments belonging to the user with the specified username","queries":{"sort_by":["created_at","votes"]},"exampleResponse":[{"comment_id":2,"body":"The beautiful thing about treasure is that it exists. Got to find out what kind of sheets these are; not cotton, not rayon, silky.","votes":15,"author":"butter_bridge","article_id":1,"created_at":1604113380000}]},"GET /api/users/:username/articles":{"description":"responds with an array of all the articles that belong to the user with the specified username","queries":{"sort_by":["votes"]},"exampleResponse":[{"article_id":11,"title":"Am I a cat?","topic":"mitch","author":"icellusedkars","body":"Having run out of ideas for articles, I am staring at the wall blankly, like a cat. Does this make me a cat?","created_at":1579126860000,"article_img_url":"https://images.pexels.com/photos/158651/news-newsletter-newspaper-information-158651.jpeg?w=700&h=700"}]},"PATCH /api/auth/login":{"queries":{},"exampleRequest":{"username":"icellusedkars"},"exampleResponse":{"username":"icellusedkars","name":"sam","avatar_url":"https://avatars2.githubusercontent.com/u/24604688?s=460&v=4","is_logged_in":true}}}