endpoints.json

{
  "GET /api": {
    "description": "serves up a json representation of all the available endpoints of the api"
  },
  "GET /api/users": {
    "description": "returns all users, each object contains details about the user (username, name and avatar_url)",
    "exampleResponse": {
      "users": [
        {
          "username": "butter_bridge",
          "name": "jonny",
          "avatar_url": "https://www.healthytherapies.com/wp-content/uploads/2016/06/Lime3.jpg"
        }
      ]
    }
  },
  "GET /api/users/:username": {
    "description": "returns the specified user object",
    "exampleResponse": {
      "user": {
        "username": "icellusedkars",
        "name": "sam",
        "avatar_url": "https://avatars2.githubusercontent.com/u/24604688?s=460&v=4"
      }
    }
  },
  "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": ["topic", "sort_by", "order"],
    "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": "returns an article object for the specified article ID",
    "exampleResponse": {
      "article": {
        "article_id": 1,
        "title": "Living in the shadow of a great man",
        "topic": "mitch",
        "author": "butter_bridge",
        "body": "I find this existence challenging",
        "created_at": "2020-07-09T20:11:00.000Z",
        "votes": 100,
        "article_img_url": "https://images.pexels.com/photos/158651/news-newsletter-newspaper-information-158651.jpeg?w=700&h=700",
        "comment_count": 3
      }
    }
  },
  "GET /api/articles/:article_id/comments": {
    "description": "returns an array of comments for the specified article ID",
    "exampleResponse": {
      "comment_id": 5,
      "body": "I hate streaming noses",
      "article_id": 1,
      "author": "icellusedkars",
      "votes": 0,
      "created_at": "2020-11-03T21:00:00.000Z"
    }
  },
  "POST /api/articles": {
    "description": "posts an article and returns the posted article. Must use a username that already exists and body must be a string",
    "examplePost": {
      "author": "icellusedkars",
      "title": "Windy Road",
      "body": "A very interesting read full of twists and turns",
      "topic": "paper",
      "article_img_url": "https://as1.ftcdn.net/v2/jpg/01/17/18/72/1000_F_117187243_oxda4jQ0sd1dTFhY7CSn6QMofcQKPqM3.jpg"
    },
    "exampleResponse": {
      "article_id": 14,
      "votes": 0,
      "comment_count": 0,
      "author": "icellusedkars",
      "title": "Windy Road",
      "body": "A very interesting read full of twists and turns",
      "topic": "paper",
      "article_img_url": "https://as1.ftcdn.net/v2/jpg/01/17/18/72/1000_F_117187243_oxda4jQ0sd1dTFhY7CSn6QMofcQKPqM3.jpg",
      "created_at": "2020-07-09T20:11:00.000Z"
    }
  },
  "POST /api/articles/:article_id/comments": {
    "description": "posts a comment on the selected article and returns the posted comment. Must use a username that already exists and body must be a string",
    "examplePost": {
      "username": "icellusedkars",
      "body": "comment"
    },
    "exampleResponse": {
      "comment": {
        "article_id": 7,
        "author": "icellusedkars",
        "body": "comment",
        "comment_id": 19,
        "votes": 0
      }
    }
  },
  "PATCH /api/articles/:article_id": {
    "description": "adjusts the specified articles vote count and returns the updated article",
    "examplePost": { "inc_votes": 1 },
    "exampleResponse": {
      "article": {
        "article_id": 1,
        "title": "Living in the shadow of a great man",
        "topic": "mitch",
        "author": "butter_bridge",
        "body": "I find this existence challenging",
        "created_at": "2020-07-09T20:11:00.000Z",
        "votes": 101,
        "article_img_url": "https://images.pexels.com/photos/158651/news-newsletter-newspaper-information-158651.jpeg?w=700&h=700"
      }
    }
  },
  "DELETE /api/comments/:comment_id": {
    "description": "deletes the specified comment"
  },
  "PATCH /api/comments/:comment_id": {
    "description": "adjusts the specified comments vote count (via an object with inc_votes key) and returns the updated comment",
    "examplePost": { "inc_votes": 4 },
    "exampleResponse": {
      "comment": {
        "body": "Oh, I've got compassion running out of my nose, pal! I'm the Sultan of Sentiment!",
        "votes": 20,
        "author": "butter_bridge",
        "article_id": 9,
        "created_at": "2020-07-09T20:11:00.000Z"
      }
    }
  }
}