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/:article_id": {
    "description": "serves an article by its id",
    "queries": [],
    "exampleResponse": {
      "article": {
        "article_id": 0,
        "title": "Seafood substitutions are increasing",
        "topic": "cooking",
        "author": "weegembump",
        "body": "Text from the article..",
        "created_at": "2018-05-30T15:59:13.341Z",
        "votes": 0,
        "article_img_url": "https://images.pexels.com/photos/123456/pexels-photo-123456.jpeg?w=700&h=700",
        "comment_count": 0
      }
    }
  },
  "GET /api/articles": {
    "description": "serves an array of all articles",
    "queries": ["sort_by", "order", "topic"],
    "exampleResponse": {
      "articles": [
        {
          "article_id": 0,
          "title": "Seafood substitutions are increasing",
          "topic": "cooking",
          "author": "weegembump",
          "created_at": "2018-05-30T15:59:13.341Z",
          "votes": 0,
          "article_img_url": "https://images.pexels.com/photos/123456/pexels-photo-123456.jpeg?w=700&h=700",
          "comment_count": 0
        },
        {
          "title": "UNCOVERED: catspiracy to bring down democracy",
          "topic": "cats",
          "author": "rogersop",
          "created_at": "2018-05-30T15:59:13.341Z",
          "votes": 0,
          "article_img_url": "https://images.pexels.com/photos/123456/pexels-photo-123456.jpeg?w=700&h=700",
          "comment_count": 0
        }
      ]
    }
  },
  "GET / api/articles/:article_id/comments": {
    "description": "serves an array of comments for a given article_id",
    "queries": ["sort_by", "order"],
    "exampleResponse": {
      "comments": [
        {
          "comment_id": 0,
          "body": "I hate streaming noses",
          "article_id": 1,
          "author": "icellusedkars",
          "votes": 0,
          "created_at": "2018-05-30T15:59:13.341Z"
        }
      ]
    }
  },

"GET /api/users": {
  "description": "serves an array of all the users",
  "queries": [],
  "exampleResponse": {
    "users": [
      {
        "username": "username1",
        "name": "name1",
        "avatar_url": "https://avators.pexels.com/photos/123456/pexels-photo-123456.jpeg?w=700&h=700"
      },
      {
        "username": "username2",
        "name": "name2",
        "avatar_url": "https://avators.pexels.com/photos/123456/pexels-photo-123456.jpeg?w=700&h=700"
      }
    ]
  }
},

  "POST /api/articles/:article_id/comments": {
    "description": "posts a comment to a given article_id",
    "queries": [],
    "exampleRequest": {
      "username": "butter_bridge",
      "body": "This is a comment."
    },
    "exampleResponse": {
      "comment": {
        "comment_id": 1,
        "author": "butter_bridge",
        "article_id": 1,
        "votes": 0,
        "created_at": "2018-05-30T15:59:13.341Z",
        "body": "This is a comment."
      }
    }
  },
  "PATCH /api/articles/:article_id": {
    "description": "updates votes of an article by article_id",
    "queries": [],
    "exampleRequest": {
      "inc_votes": 101
    },
    "exampleResponse": {
      "article": {
        "article_id": 0,
        "title": "Seafood substitutions are increasing",
        "topic": "cooking",
        "author": "weegembump",
        "body": "Text from the article..",
        "created_at": "2018-05-30T15:59:13.341Z",
        "votes": 101,
        "article_img_url": "https://images.pexels.com/photos/123456/pexels-photo-123456.jpeg?w=700&h=700"
      }
    }
  },
  "DELETE /api/comments/:comment_id": {
    "description": "deletes a comment by comment_id",
    "queries": [],
    "exampleResponse": {}
  }
}