endpoints.json

{
  "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 topics",
    "queries": ["author", "topic", "sort_by", "order"],
    "exampleResponse": {
      "articles": [
        {
          "title": "Seafood substitutions are increasing",
          "topic": "cooking",
          "author": "weegembump",
          "body": "Text from the article..",
          "created_at": 1527695953341
        }
      ]
    }
  }, 
  "GET /api/users":{
    "description":"serves 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"
    }
  ]
}
}
 ,
"GET /api/articles/:article_id":{
  "description":"serves a specific article",
    "queries": [],
    "ExampleResponse":{
   "article":{
  "comment_count":2,
  "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":0
  }
}
}
,
"GET /api/articles/:article_id/comments":{
  "description":"serves an array of comments of a given article id",
  "queries": [],
  "ExampleResponse": 
    [{"comment_id":14,"body":"What do you see? I have no idea where this will lead us. This place I speak of, is known as the Black Lodge.","author":"icellusedkars","votes":16,"created_at":"2020-06-09T05:00:00.000Z"},{"comment_id":15,"body":"I am 100% sure that we're not completely sure.","author":"butter_bridge","votes":1,"created_at":"2020-11-24T00:08:00.000Z"}]

  

},
"PATCH /api/articles/:article_id'": {
  "description": "serves an updated article when there is an increase in votes'",
  "queries": [],
  "exampleRequest": {" inc_votes": 100 },
  "exampleResponse": {
      "article_id": 3,
      "title": "Eight pug gifs that remind me of mitch",
      "topic": "mitch",
     " author": "icellusedkars",
     " body": "some gifs",
      "created_at": "2020-11-03T09:12:00.000Z",
      "votes": 100
      
    
  }
},
"POST api/articles/:article_id/comments":{
  "description":  "adds a new comment to the database",
  "queries":[],
  "exampleRequest":
    {"username":"lurker","body":"Amamzing article! Loved it!"}
  },
  "exampleResponse":{
    "comment":{
      "comment_id":19,
      "body":"Amamzing article! Loved it!",
      "article_id":4,"author":"lurker","votes":0,"created_at":"2022-11-01T15:13:08.081Z"
    }
  },
  "DELETE /api/comments/:comment_id":{
    "description": "removes the comment of a given comment id",
    "queries":[],
    "exampleResponse":{}
  }
}