{"endpoints":{"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 - filters articles by topic (optional)","sort_by (default: created_at)","order (default: desc, valid options: asc, desc)"],"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":"Retrieves a single article by its ID.","queries":[],"exampleResponse":{"article":{"author":"butter_bridge","title":"Living in the shadow of a great man","article_id":1,"body":"I find this existence challenging...","topic":"mitch","created_at":"2020-07-09T20:11:00.000Z","votes":100,"article_img_url":"https://example.com/image.jpg"}}},"GET /api/articles/:article_id/comments":{"description":"Retrieves all comments for a given article ID.","queries":[],"exampleResponse":{"comments":[{"comment_id":1,"votes":16,"created_at":1586179020000,"author":"butter_bridge","body":"Oh, I've got compassion running out of my nose, pal! I'm the Sultan of Sentiment!","article_title":"They're not exactly dogs, are they?","article_id":3},{"comment_id":2,"votes":14,"created_at":1604113380000,"author":"butter_bridge","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.","article_title":"Living in the shadow of a great man","article_id":3}]}},"POST /api/articles/:article_id/comments":{"description":"Posts a new comment for a given article ID.","queries":[],"requestBody":{"username":"string (required)","body":"string (required)"},"exampleRequestBody":{"username":"lurker","body":"Code is fun... until it isn’t. Then it's just debugging."},"exampleResponse":{"comment":{"comment_id":1,"article_id":3,"author":"lurker","body":"Code is fun... until it isn’t. Then it's just debugging.","votes":0,"created_at":"2025-03-12T15:00:00.000Z"}}},"PATCH /api/articles/:article_id":{"description":"Updates the number of votes for a given article ID.","queries":[],"requestBody":{"inc_votes":"Number (required)"},"exampleRequestBody":{"inc_votes":1},"exampleResponse":{"article":{"title":"Another article about Mitch","topic":"mitch","author":"butter_bridge","body":"There will never be enough articles about Mitch!","created_at":1602419040000,"votes":1,"article_img_url":"https://images.pexels.com/photos/158651/news-newsletter-newspaper-information-158651.jpeg?w=700&h=700"}}},"PATCH /api/comments/:comment_id":{"description":"Updates the votes for a given comment ID.","queries":[],"requestBody":{"inc_votes":"Number (required)"},"exampleRequestBody":{"inc_votes":1},"exampleResponse":{"comment":{"comment_id":1,"author":"butter_bridge","body":"Oh, I've got compassion running out of my nose, pal! I'm the Sultan of Sentiment!","votes":17,"created_at":1586179020000,"article_title":"They're not exactly dogs, are they?","article_id":3}}},"DELETE /api/comments/:comment_id":{"description":"Deletes a comment by its ID. If the comment exists, it is removed and the response status is 204 (No Content). If the comment does not exist, responds with a 404 error.","queries":[],"exampleResponse":{"status":204}},"GET /api/users":{"description":"serves an array of all users","queries":[],"exampleResponse":{"users":[{"username":"rogersop","name":"paul","avatar_url":"https://avatars2.githubusercontent.com/u/24394918?s=400&v=4"}]}},"GET /api/users/:username":{"description":"Retrieves a single user by their username.","queries":[],"exampleResponse":{"user":{"username":"butter_bridge","name":"jonny","avatar_url":"https://www.healthytherapies.com/wp-content/uploads/2016/06/Lime3.jpg"}}}}}