{"endpoint":{"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!"}]}},"POST /api/topics":{"description":"adds a new topic","queries":[],"body":{"slug":"topic name here","description":"description here"},"exampleResponse":{"newTopic":{"slug":"football","description":"Footie!"}}},"GET /api/articles":{"description":"serves an array of all topics","queries":["topic","sort_by","order"],"exampleResponse":{"articles":[{"title":"Seafood substitutions are increasing","topic":"cooking","author":"weegembump","body":"Text from the article..","created_at":1527695953341,"total_count":100}]}},"POST /api/articles":{"description":"adds a new article","body":{"author":"grumpy19","title":"The Notorious MSG’s Unlikely Formula For Success","topic":"cooking","votes":0,"article_img_url":"https://images.pexels.com/photos/2403392/pexels-photo-2403392.jpeg?w=700&h=700"},"exampleResponse":{"newArticle":{"author":"grumpy19","title":"The Notorious MSG’s Unlikely Formula For Success","article_id":34,"topic":"cooking","created_at":"2020-11-22T11:13:00.000Z","votes":0,"article_img_url":"https://images.pexels.com/photos/2403392/pexels-photo-2403392.jpeg?w=700&h=700","comment_count":"11"}}},"GET /api/articles/:article_id":{"description":"serves an array of all articles based on article_id","queries":["article_id"],"exampleResponse":{"articles":[{"title":"Seafood substitutions are increasing","article_id":1,"topic":"cooking","author":"weegembump","body":"Text from the article..","created_at":1527695953341,"votes":10,"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":"deletes article with the article_id","queries":["article_id"],"exampleResponse":{}},"GET /api/articles/:article_id/comments":{"description":"serves an array of all comments for a given article_id","queries":["article_id"],"exampleResponse":{"comments":[{"comment_id":9,"body":"Superficially charming","article_id":1,"author":"icellusedkars","votes":0,"created_at":"2020-01-01T03:08:00.000Z","total_count":100}]}},"PATCH /api/articles/:article_id":{"description":"patches the article votes based on article_id and increments or decrements based on newVotes value","queries":["article_id"],"body":{"inc_votes":"newVote"},"exampleResponse":{"articles":[{"title":"Seafood substitutions are increasing","article_id":1,"topic":"cooking","author":"weegembump","body":"Text from the article..","created_at":1527695953341,"votes":20,"article_img_url":"https://images.pexels.com/photos/158651/news-newsletter-newspaper-information-158651.jpeg?w=700&h=700"}]}},"POST /api/articles/:article_id/comments":{"description":"posts a new comment on the article provided there is an article_id","queries":["article_id"],"body":{"username":"a username which exists","body":"newBody"},"exampleResponse":{"newItem":[{"comment_id":19,"body":"Hello my name sam","article_id":1,"author":"butter_bridge","votes":0,"created_at":"2023-02-22T12:02:13.693Z"}]}},"DELETE /api/comments/:comments_id":{"description":"delete the given comment by comment_id","queries":["comment_id"],"exampleResponse":{}},"GET /api/users":{"description":"serves an array of all users based on article_id","queries":["article_id"],"exampleResponse":{"users":[{"username":"tickle122","name":"Tom Tickle","avatar_url":"https://vignette.wikia.nocookie.net/mrmen/images/d/d6/Mr-Tickle-9a.png/revision/latest?cb=20180127221953"},{"username":"grumpy19","name":"Paul Grump","avatar_url":"https://vignette.wikia.nocookie.net/mrmen/images/7/78/Mr-Grumpy-3A.PNG/revision/latest?cb=20170707233013"},{"username":"happyamy2016","name":"Amy Happy","avatar_url":"https://vignette1.wikia.nocookie.net/mrmen/images/7/7f/Mr_Happy.jpg/revision/latest?cb=20140102171729"},{"username":"cooljmessy","name":"Peter Messy","avatar_url":"https://vignette.wikia.nocookie.net/mrmen/images/1/1a/MR_MESSY_4A.jpg/revision/latest/scale-to-width-down/250?cb=20170730171002"},{"username":"weegembump","name":"Gemma Bump","avatar_url":"https://vignette.wikia.nocookie.net/mrmen/images/7/7e/MrMen-Bump.png/revision/latest?cb=20180123225553"},{"username":"jessjelly","name":"Jess Jelly","avatar_url":"https://vignette.wikia.nocookie.net/mrmen/images/4/4f/MR_JELLY_4A.jpg/revision/latest?cb=20180104121141"}]}},"GET /api/users/:username":{"description":"serves user object based on username provided","queries":["username"],"exampleResponse":{"users":[{"username":"tickle122","name":"Tom Tickle","avatar_url":"https://vignette.wikia.nocookie.net/mrmen/images/d/d6/Mr-Tickle-9a.png/revision/latest?cb=20180127221953"}]}},"PATCH /api/comments/:comment_id":{"description":"can increment or decrement votes of comments based on comment_id","queries":["comment_id"],"body":{"inc_votes":100},"exampleResponse":{"comments":{"comment_id":162,"body":"Et suscipit maxime sit sunt consequuntur consequatur fugiat molestias. Et quis enim vero.","article_id":2,"author":"grumpy19","votes":114,"created_at":"2020-10-03T19:22:00.000Z"}}},"DELETE /api/comments/:comment_id":{"description":"can delete comment with comment_id provided","queries":["comment_id"],"exampleResponse":{}}}}