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 articles",
    "queries": ["topic"],
    "exampleResponse": {
      "articles": [
        {
          "article_id": 999,
          "title": "Seafood substitutions are increasing",
          "topic": "cooking",
          "author": "weegembump",
          "created_at": "2018-05-30T15:59:13.341Z",
          "votes": 0,
          "comment_count": 6
        }
      ]
    }
  },
  "GET /api/articles/:article_id": {
    "description": "serves an individual article via the :article_id",
    "queries": [],
    "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": 1594329060000,
        "votes": 100,
        "article_img_url":
          "https://images.pexels.com/photos/158651/news-newsletter-newspaper-information-158651.jpeg?w=700&h=700",
        "comment_count": 0
      }
    }
  },
  "GET /api/articles/:article_id/comments": {
    "description": "serves an array of comments via the :article_id",
    "queries": [],
    "exampleResponse": {
      "comments": [
        {
            "comment_id": 1,
            "votes": 16,
            "created_at": "2020-04-06 13:17:00",
            "author": "butter_bridge",
            "body": "Oh, I've got compassion running out of my nose, pal! I'm the Sultan of Sentiment!",
            "article_id": 9
        },
        {
          "comment_id": 17,
          "votes": 20,
          "created_at": "2020-03-14 17:02:00",
          "author": "icellusedkars",
          "body": "The owls are not what they seem.",
          "article_id": 9
        }
      ]
    }
  },
  "POST /api/articles/:article_id/comments": {
    "description": "accepts a body consisting of a comment tied to an article via the :article_id",
    "body": {
      "username": "example",
      "body": "example"
    },
    "exampleResponse": {
      "comment": {
        "comment_id": 42,
        "votes": 0,
        "created_at": "2020-04-06 13:17:00",
        "author": "example",
        "body": "example",
        "article_id": 42
      }
    }
  },
  "PATCH /api/comments/:comment_id": {
    "description": "accepts a body consisting of a vote count to increment a comment by through the :comment_id",
    "body": {
      "inc_votes": 42
    },
    "exampleResponse": {
      "comment": {
        "comment_id": 42,
        "votes": 0,
        "created_at": "2020-04-06 13:17:00",
        "author": "example",
        "body": "example",
        "article_id": 42
      }
    }
  },
  "PATCH /api/articles/:article_id": {
    "description": "accepts a body consisting of a vote count to increment an article by through the :article_id",
    "body": {
      "inc_votes": 42
    },
    "exampleResponse": {
      "article": {
        "article_id": 999,
        "title": "Seafood substitutions are increasing",
        "topic": "cooking",
        "author": "weegembump",
        "created_at": "2018-05-30T15:59:13.341Z",
        "votes": 0,
        "comment_count": 6
      }
    }
  },
  "DELETE /api/comments/:comment_id": {
    "description": "deletes a comment as identified by comment_id"
  },
  "GET /api/users": {
    "description": "serves an array of all users",
    "queries": [],
    "exampleResponse": {
      "users": [
        {
          "username": "rogersop",
          "name": "paul",
          "avatar_url": "https://avatars2.githubusercontent.com/u/24394918?s=400&v=4"
        },
        {
          "username": "lurker",
          "name": "do_nothing",
          "avatar_url": "https://www.golenbock.com/wp-content/uploads/2015/01/placeholder-user.png"
        }
      ]
    }
  },
  "GET /api/user/:username": {
    "description": "responds with a single user selected by :username or a 404",
    "queries": [],
    "exampleResponse": {
      "user": {
        "username": "rogersop",
        "name": "paul",
        "avatar_url": "https://avatars2.githubusercontent.com/u/24394918?s=400&v=4" 
      }
    }
  }
}