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!"
        }
      ]
    }
  },
  "POST /api/topics": {
    "description": "creates a new topic",
    "requestBody": [
      "slug",
      "description"
    ],
    "exampleResponse": {
      "topics": [
        {
          "slug": "topic name here",
          "description": "description here"
        }
      ]
    }
  },
  "GET /api/articles": {
    "description": "serves an array of all articles by queries",
    "queries": [
      "author",
      "topic",
      "sort_by",
      "order",
      "limit",
      "p"
    ],
    "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
        }
      ],
      "total_count": 36
    }
  },
  "GET /api/articles/:article_id": {
    "description": "serves an article by 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"
      }
    }
  },
  "GET /api/articles/:article_id/comments": {
    "description": "serves an array of all comments by article_id",
    "queries": [
      "limit",
      "p"
    ],
    "exampleResponse": {
      "comments": [
        {
          "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/:article_id/comments": {
    "description": "adds a comment for an article by username",
    "requestBody": [
      "username",
      "body"
    ],
    "exampleResponse": {
      "comment": {
        "comment_id": 303,
        "body": "A Cat",
        "article_id": 1,
        "author": "happyamy2016",
        "votes": 0,
        "created_at": "2024-01-16T22:31:04.613Z"
      }
    }
  },
  "POST /api/article": {
    "description": "create a new article in DB",
    "requestBody": [
      "author",
      "title",
      "body",
      "topic",
      "article_img_url"
    ],
    "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": 6
      }
    }
  },
  "PATCH /api/articles/:article_id": {
    "description": "updates an article's vote by article_id",
    "requestBody": {
      "inc_votes": 10
    },
    "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": 110,
        "article_img_url": "https://images.pexels.com/photos/158651/news-newsletter-newspaper-information-158651.jpeg?w=700&h=700"
      }
    }
  },
  "DELETE /api/articles/:article_id": {
    "description": "delete article from DB by article_id"
  },
  "DELETE /api/comments/:comment_id": {
    "description": "delete comment from DB by comment_id"
  },
  "PATCH /api/comments/:comment_id": {
    "description": "updates an comment's vote by comment_id",
    "requestBody": {
      "inc_votes": 10
    },
    "exampleResponse": {
      "comment": {
        "comment_id": 303,
        "body": "A Cat",
        "article_id": 1,
        "author": "happyamy2016",
        "votes": 10,
        "created_at": "2024-01-16T22:31:04.613Z"
      }
    }
  },
  "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/users/:username": {
    "description": "serves an object with user's data",
    "exampleResponse": {
      "users": {
        "username": "butter_bridge",
        "name": "jonny",
        "avatar_url": "https://www.healthytherapies.com/wp-content/uploads/2016/06/Lime3.jpg"
      }
    }
  }
}