{"endpoints":{"GET /api":{"description":"serves up a json representation of all the available endpoints of the api","queries":[],"exampleResponse":{"endpoints":{"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","limit","p"],"exampleResponse":{"articles":[{"article_id":5,"title":"UNCOVERED: catspiracy to bring down democracy","topic":"cats","author":"rogersop","created_at":"2020-08-03 14:14:00","votes":0,"article_img_url":"https://images.pexels.com/photos/158651/news-newsletter-newspaper-information-158651.jpeg?w=700&h=700","comment_count":2}]}},"POST /api/articles":{"description":"post a new article","queries":[],"requestFormat":{"title":"How to make an object fly","topic":"paper","author":"lurker","body":"Wingardium Leviosa"},"exampleResponse":{"comment":[{"article_id":14,"title":"How to make an object fly","topic":"paper","author":"lurker","body":"Text from the article..","created_at":"2020-10-11 12:24:00","votes":0,"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 an article by id","queries":[],"exampleResponse":{"article":[{"article_id":1,"title":"Living in the shadow of a great man","topic":"mitch","author":"butter_bridge","body":"Text from the article..","created_at":"2020-07-09 21:11:00","votes":100,"article_img_url":"https://images.pexels.com/photos/158651/news-newsletter-newspaper-information-158651.jpeg?w=700&h=700","comment_count":11}]}},"PATCH /api/articles/:article_id":{"description":"update vote counts for that article","queries":[],"requestFormat":{"inc_votes":"number"},"exampleResponse":{"article":[{"article_id":2,"title":"Sony Vaio; or, The Laptop","topic":"mitch","author":"icellusedkars","body":"Text from the article..","created_at":"2020-10-16 06:03:00","votes":1,"article_img_url":"https://images.pexels.com/photos/158651/news-newsletter-newspaper-information-158651.jpeg?w=700&h=700"}]}},"DELETE /api/articles/:article_id":{"description":"delete article by article_id","queries":[]},"GET /api/articles/:article_id/comments":{"description":"serves an array of all comments for one article","queries":["limit","p"],"exampleResponse":{"comments":[{"comment_id":5,"body":"I hate streaming noses","article_id":1,"author":"icellusedkars","votes":0,"created_at":"2020-11-03 21:00:00"}]}},"POST /api/articles/:article_id/comments":{"description":"post a comment to that article","queries":[],"requestFormat":{"body":"string","author":"string"},"exampleResponse":{"comment":[{"comment_id":19,"body":"Both laptops are crap!","article_id":2,"author":"lurker","votes":0,"created_at":"2024-05-28 17:13:00"}]}},"PATCH /api/comments/:comment_id":{"description":"update vote counts for that comment","queries":[],"requestFormat":{"inc_votes":"number"},"exampleResponse":{"comment":[{"comment_id":14,"body":"Text from the article..","article_id":5,"author":"icellusedkars","votes":20,"created_at":"2020-06-09 06:00:00"}]}},"DELETE /api/comments/:comment_id":{"description":"delete comment by comment_id","queries":[]},"GET /api/users":{"description":"serve an array of all users","queries":[],"exampleResponse":{"users":[{"username":"butter_bridge","name":"jonny","avatar_url":"https://www.golenbock.com/wp-content/uploads/2015/01/placeholder-user.png"}]}},"GET /api/users/:username":{"description":"serve the user with this username","queries":[],"exampleResponse":{"users":[{"username":"icellusedkars","name":"sam","avatar_url":"https://avatars2.githubusercontent.com/u/24604688?s=460&v=4"}]}},"GET /api/topics":{"description":"serves an array of all topics","queries":[],"exampleResponse":{"topics":[{"slug":"football","description":"Footie!"}]}},"POST /api/topics":{"description":"post a new topic","queries":[],"requestFormat":{"slug":"magic","description":"How to summon a unicorn"},"exampleResponse":{"slug":"magic","description":"How to summon a unicorn"}}}}