{"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 the article with the specified ID.","queries":["article_id"],"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":"expect.any(String)","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 all the comments under the article with the specified ID.","queries":["article_id","comments"],"exampleResponse":{"comments":{"comment_id":10,"body":"git push origin master","article_id":3,"author":"icellusedkars","votes":0,"created_at":"2020-06-20T07:24:00.000Z"}}},"POST /api/articles/:article_id/comments":{"description":"Adds a comment to an article with the specified ID.","queries":["article_id","comments","username","body"],"exampleResponse":{"comment":{"comment_id":19,"body":"Oh, I've got compassion running out of my nose, pal! I'm the Sultan of Sentiment!","article_id":4,"author":"butter_bridge","votes":0,"created_at":"2024-07-28T21:26:34.713Z"}}},"PATCH /api/articles/:article_id":{"description":"Updates an article by the votes count when a valid ID is provided.","queries":["article_id","inc_votes"],"exampleResponse":{"article":{"article_id":5,"title":"UNCOVERED: catspiracy to bring down democracy","topic":"cats","author":"rogersop","body":"Bastet walks amongst us, and the cats are taking arms!","created_at":"2020-08-03T13:14:00.000Z","votes":-1,"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 a comment on an article when a valid comment ID is provided.","queries":["comment_id"],"exampleResponse":{"comments":{}}},"GET /api/users":{"description":"Serves an array of all users.","queries":["users"],"exampleResponse":{"users":[{"username":"butter_bridge","name":"jonny","avatar_url":"https://www.healthytherapies.com/wp-content/uploads/2016/06/Lime3.jpg"}]}},"GET /api/users/:username":{"description":"Serves a user by username.","queries":[],"exampleResponse":{"user":{"username":"butter_bridge","name":"jonny","avatar_url":"https://www.healthytherapies.com/wp-content/uploads/2016/06/Lime3.jpg"}}}}