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": [
        {
          "author": "weegembump",
          "title": "Seafood substitutions are increasing",
          "article_id": 33,
          "topic": "cooking",
          "created_at": "2018-05-30T15:59:13.341Z",
          "votes": 0,
          "comment_count": "6"
        }
      ]
    }
  },
  "POST /api/articles": {
    "description": "inserts a new article and responds with that article",
    "queries": [],
    "exampleResponse": {
      "article": {
        "article_id": 37,
        "title": "Article Title",
        "body": "An article body",
        "votes": 0,
        "topic": "cooking",
        "author": "jessjelly",
        "created_at": "2019-05-12T21:56:22.669Z",
        "comment_count": 0
      }
    }
  },
  "GET /api/articles/:article_id": {
    "description": "serves an article object",
    "queries": [],
    "exampleResponse": {
      "article": {
        "author": "jessjelly",
        "title": "Running a Node App",
        "article_id": 1,
        "topic": "coding",
        "created_at": "2016-08-18T12:07:52.389Z",
        "votes": 24,
        "body": "The text of the body...",
        "comment_count": "8"
      }
    }
  },
  "PATCH /api/articles/:article_id": {
    "description": "accepts an object in the form { inc_votes: newVote } and updates the article's votes property. Responds with the updated article",
    "queries": [],
    "patch body": { "inc_votes": "newVote (num)" },
    "exampleResponse": {
      "article": {
        "author": "jessjelly",
        "title": "Running a Node App",
        "article_id": 1,
        "topic": "coding",
        "created_at": "2016-08-18T12:07:52.389Z",
        "votes": 25,
        "body": "The text of the body...",
        "comment_count": "8"
      }
    }
  },
  "GET /api/articles/:article_id/comments": {
    "description": "serves an array of comments for the specified article",
    "queries": ["sort_by", "order"],
    "exampleResponse": {
      "comments": [
        {
          "comment_id": 44,
          "votes": 4,
          "created_at": "2017-11-20T08:58:48.322Z",
          "author": "grumpy19",
          "body": "Error est qui id corrupti et quod enim accusantium minus. Deleniti quae ea magni officiis et qui suscipit non."
        }
      ]
    }
  },
  "POST /api/articles/:article_id/comments": {
    "description": "inserts a new comment and responds with that comment",
    "queries": [],
    "post body": {
      "username": "jessjelly",
      "body": "example"
    },
    "exampleResponse": {
      "comment": {
        "comment_id": 301,
        "author": "jessjelly",
        "article_id": 1,
        "votes": 0,
        "created_at": "2019-05-11T22:27:32.949Z",
        "body": "example"
      }
    }
  },
  "PATCH /api/comments/comment_id": {
    "description": "accepts an object in the form { inc_votes: newVote } and updates the comment's votes property. Responds with the updated comment",
    "queries": [],
    "patch body": {
      "inc_votes": "newVote (num)"
    },
    "exampleResponse": {
      "comment": {
        "comment_id": 1,
        "author": "tickle122",
        "article_id": 18,
        "votes": 2,
        "created_at": "2016-07-09T18:07:18.932Z",
        "body": "Itaque quisquam est similique et est perspiciatis reprehenderit voluptatem autem. Voluptatem accusantium eius error adipisci quibusdam doloribus."
      }
    }
  },
  "DELETE /api/comments/comment_id": {
    "description": "deletes a comment and responds with no content",
    "queries": [],
    "exampleResponse": {}
  },
  "GET /api/users/:username": {
    "description": "responds with an object of the specified user",
    "queries": [],
    "exampleResponse": {
      "user": {
        "username": "jessjelly",
        "avatar_url": "https://s-media-cache-ak0.pinimg.com/564x/39/62/ec/3962eca164e60cf46f979c1f57d4078b.jpg",
        "name": "Jess Jelly"
      }
    }
  }
}