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 sorted by date in descending order",
		"queries": ["author", "topic", "sort_by", "order"],
		"exampleResponse": {
			"articles": [
				{
					"author": "weegembump",
					"title": "Seafood substitutions are increasing",
					"article_id": 1,
					"topic": "cooking",
					"created_at": "2018-05-30T15:59:13.341Z",
					"votes": 0,
					"article_img_url": "https://www.images.com/img.jpeg",
					"comment_count": 6
				}
			]
		}
	},
	"GET /api/articles/:article_id": {
		"description": "serves an article object",
		"queries": [],
		"exampleResponse": {
			"article": [
				{
					"author": "weegembump",
					"title": "Seafood substitutions are increasing",
					"article_id": 1,
					"body": "Text from the article..",
					"topic": "cooking",
					"created_at": "2018-05-30T15:59:13.341Z",
					"article_img_url": "https://www.images.com/img.jpeg",
					"votes": 0,
					"comment_count": 11
				}
			]
		}
	},
	"GET /api/articles/:article_id/comments": {
		"description": "serves an array of all comments for a given article ID sorted by date in descending order",
		"queries": [],
		"exampleResponse": {
			"article": [
				{
					"author": "weegembump",
					"article_id": 1,
					"comment_id": 6,
					"body": "Text from the comment..",
					"created_at": "2018-05-30T15:59:13.341Z",
					"votes": 0
				}
			]
		}
	},
	"POST /api/articles/:article_id/comments": {
		"description": "serves a newly posted comment for a given article ID",
		"queries": [],
		"exampleResponse": {
			"article": [
				{
					"author": "weegembump",
					"article_id": 1,
					"comment_id": 9,
					"body": "Text from the new comment..",
					"created_at": "2018-05-30T15:59:13.341Z",
					"votes": 0
				}
			]
		}
	},
	"PATCH /api/articles/:article_id": {
		"description": "serves an article object with updated votes property for a given article ID",
		"queries": [],
		"exampleResponse": {
			"article": [
				{
					"author": "weegembump",
					"article_id": 1,
					"comment_id": 9,
					"body": "Text from the new comment..",
					"created_at": "2018-05-30T15:59:13.341Z",
					"votes": 50
				}
			]
		}
	},
	"DELETE /api/comments/:comment_id": {
		"description": "deletes a comment for a given comment ID and does not return anything"
	},
	"GET /api/users": {
		"description": "serves an array of all users",
		"exampleResponse": {
			"users": [
				{
					"username": "lurker",
					"name": "do_nothing",
					"avatar_url": "https://www.golenbock.com/wp-content/uploads/2015/01/placeholder-user.png"
				}
			]
		}
	},
	"GET /api/users/:username": {
		"description": "serves a user object",
		"queries": [],
		"exampleResponse": {
			"user": [
				{
					"username": "lurker",
					"name": "do_nothing",
					"avatar_url": "https://www.golenbock.com/wp-content/uploads/2015/01/placeholder-user.png"
				}
			]
		}
	}
}