Questions API Documentation

Table of Contents

• General Instructions
• CRUD vs. HTTP Reference
• User Login
• User Log Out
• Register New User
• Retrieve Logged In User Info
• Update Logged In User Info
• Get User Details
• List All Questions
• Add New Question
• Single Question Details
• Update Question's Favorited Field
• Update Question's Accepted Answer
• Upvote Question
• Downvote Question
• Delete Question
• Search Questions
• Add New Answer to Question
• Edit Answer
• Delete Answer
• Search Answers
• Update Answer's Favorited Field
• Upvote Question
• Downvote Question

General Instructions

The base url for all the extensions below is: https://questions-t10.herokuapp.com/. Please be sure to use double quotes ("") for all JSON requests. Several endpoints require Token Authentication. This is done in the header of the HTTP request, with the following form:

Authentication: "Token <token string>"

Please refer to the documentation for the HTTP request library you are using to ensure the proper syntax.

CRUD vs. HTTP Reference

CRUD	HTTP
Create	POST
Read	GET
Update	PUT/PATCH
Delete	DELETE

User Login

Username and password required.

Request

POST /auth/token/login/
{
    "username": "babish",
    "password": "tinywhisk"
}

Response

200 OK
{
    "auth_token": "heybabyihearthebluesacallintossedsaladandscrambledeggs"
}

User Log Out

Token authentication required, body should be empty.

Request

POST /auth/token/logout/

Response

204 No Content

Register New User

Username, password, and retyped password required.

Request

POST /auth/users/
{
    "username": "chefjohn",
    "password": "cayennepepper",
    "re_password": "cayennepepper"
}

Response

201 Created
{
    "email": "",
    "username": "chefjohn",
    "id": 5
}

Retrieve Logged In User Info

Body should be empty.

Request

GET /auth/users/me/

Response

200 OK
{
	"username": "thomas",
	"bio": null,
	"questions": [],
	"answers": [
		{
			"pk": 2,
			"body": "Is it non-stick?",
			"author": "thomas",
			"question": 9,
			"votes": 1,
			"created_at": "2021-12-15T00:19:51.903050Z",
			"favorited": [
				3
			]
		}
	],
	"image_url": null,
	"date_joined": "2021-12-14T22:51:16.121295Z"
}

Update Logged In User Info

Token authentication required. Should correspond to user being updated. Only include fields meant to be updated.

Request

PATCH /auth/users/me/
{
    "bio": "I like the InstaPot."
}

Response

200 OK
{
	"username": "thomas",
	"bio": "I like the InstaPot.",
	"questions": [],
	"answers": [
		{
			"pk": 2,
			"body": "Is it non-stick?",
			"author": "thomas",
			"question": 9,
			"votes": 1,
			"created_at": "2021-12-15T00:19:51.903050Z",
			"favorited": [
				3
			]
		}
	],
	"image_url": null,
	"date_joined": "2021-12-14T22:51:16.121295Z"
}

Get User Details

Integer should be the id of the target user. Body should be empty.

Request

GET /user/3/

Response

200 OK
{
	"username": "thomas",
	"bio": null,
	"questions": [
		{
			"pk": 11,
			"title": "Why am I in couples counseling over a pan?",
			"body": "The cast iron skillet had a ton of gunk on it, so I went to town on it with soap and iron wool. What's the big deal?",
			"author": "thomas",
			"votes": 0,
			"created_at": "2021-12-17T11:21:43.613489Z",
			"favorited": [],
			"answered": null
		}
	],
	"answers": [
		{
			"pk": 2,
			"body": "Is it non-stick?",
			"author": "thomas",
			"question": 9,
			"votes": 1,
			"created_at": "2021-12-15T00:19:51.903050Z",
			"favorited": []
		}
	],
	"image_url": null,
	"date_joined": "2021-12-14T22:51:16.121295Z"
}

List All Questions

Body should be empty.

Request

GET /questions/

Response

200 OK
[
	{
		"pk": 10,
		"title": "What does it mean to fold in the cheese?",
		"body": "Do you fold it in half like a piece of paper and drop it in the pot?",
		"author": "admin",
		"votes": 0,
		"answers": [],
		"created_at": "2021-12-15T13:31:42.189621Z",
		"favorited": [],
		"answered": null
	},
    (...)
]

Add New Question

Token authentication required. Title field is required, body field is optional.

Request

POST /questions/
{
    "title": "Why am I in couples counseling over a pan?",
    "body": "The cast iron skillet had a ton of gunk on it, so I went to town on it with soap and iron wool. What's the big deal?"
}

Response

201 Created
{
	"pk": 11,
	"title": "Why am I in couples counseling over a pan?",
	"body": "The cast iron skillet had a ton of gunk on it, so I went to town on it with soap and iron wool. What's the big deal?",
	"author": "thomas",
	"votes": 0,
	"answers": [],
	"created_at": "2021-12-17T11:21:43.613489Z",
	"favorited": [],
	"answered": null
}

Single Question Details

Integer should be the id of the target question. Body should be empty.

Request

GET /questions/9/

Response

200 OK
{
	"pk": 9,
	"title": "Why is my knife so dull?",
	"body": "I make sure to run it in the dishwasher after every use...",
	"author": "admin",
	"votes": 1,
	"answers": [
		{
			"pk": 1,
			"body": "You should let it soak at least 30 minutes before you put it in the dishwasher.",
			"author": "james",
			"question": 9,
			"votes": 1,
			"created_at": "2021-12-15T00:19:28.001432Z",
			"favorited": []
		}
	],
	"created_at": "2021-12-15T00:10:31.523378Z",
	"favorited": [],
	"answered": null
}

Update Question's Favorited Field

Token authentication required. If User has already favorited the question, their pk will be removed from the Favorited field.

Request

PATCH /questions/9/
{
	"favorited": []
}

Response

200 OK
{
	"pk": 10,
	"title": "What does it mean to fold in the cheese?",
	"body": "Do you fold it in half like a piece of paper and drop it in the pot?",
	"author": "admin",
	"votes": 0,
	"answers": [],
	"created_at": "2021-12-15T13:31:42.189621Z",
	"favorited": [
		3
	],
	"answered": null
}

Update Question's Accepted Answer

Token authentication required. Authenticated user must match the author of the question. Set field value to the pk of the desired answer. To set no accepted answer, set value to null.

Request

PATCH /questions/9/
{
	"answered": 1
}

Response

200 OK
{
	"pk": 9,
	"title": "Why is my knife so dull?",
	"body": "I make sure to run it in the dishwasher after every use...",
	"author": "admin",
	"votes": 1,
	"answers": [
		{
			"pk": 1,
			"body": "You should let it soak at least 30 minutes before you put it in the dishwasher.",
			"author": "james",
			"question": 9,
			"votes": 1,
			"created_at": "2021-12-15T00:19:28.001432Z",
			"favorited": []
		},
		(...)
	],
	"created_at": "2021-12-15T00:10:31.523378Z",
	"favorited": [
		1,
		2
	],
	"answered": 1
}

Upvote Question

Token authentication required. Field value should be an empty list (or array, for the Javascript-inclined).

Request

PATCH /questions/10/
{
	"upvotes": []
}

Response

200 OK
{
	"pk": 10,
	"title": "What does it mean to fold in the cheese?",
	"body": "Do you fold it in half like a piece of paper and drop it in the pot?",
	"author": "admin",
	"votes": 1,
	"upvotes": [
		3
	],
	"downvotes": [],
	"answers": [],
	"created_at": "2021-12-15T13:31:42.189621Z",
	"favorited": [
		3
	],
	"answered": null,
	"tags": []
}

Downvote Question

Token authentication required. Field value should be an empty list (or array, for the Javascript-inclined).

Request

PATCH /questions/10/
{
	"downvotes": []
}

Response

200 OK
{
	"pk": 10,
	"title": "What does it mean to fold in the cheese?",
	"body": "Do you fold it in half like a piece of paper and drop it in the pot?",
	"author": "admin",
	"votes": -1,
	"upvotes": [],
	"downvotes": [
		2
	],
	"answers": [],
	"created_at": "2021-12-15T13:31:42.189621Z",
	"favorited": [
		3
	],
	"answered": null,
	"tags": []
}

Delete Question

Token authentication required. Authentication should match the author of the question. Body should be empty.

Request

DELETE /questions/11/

Response

204 No Content

Search Questions

Spaces in search term need to replaced by a +. Body should be empty.

Request

GET /questions?search=knife

Response

200 OK
[
	{
		"pk": 9,
		"title": "Why is my knife so dull?",
		"body": "I make sure to run it in the dishwasher after every use...",
		"author": "admin",
		"votes": 1,
		"created_at": "2021-12-15T00:10:31.523378Z",
		"favorited": [
			1,
			2,
			3
		],
		"answered": null
	}
]

Add New Answer to Question

Token authentication required. Body field required.

Request

POST /questions/10/answers/
{
	"body": "I think you fold it hot dog style, not hamburger."
}

Response

201 Created
{
	"pk": 4,
	"body": "I think you fold it hot dog style, not hamburger.",
	"author": {
		"pk": 2,
		"username": "james"
	},
	"question": 10,
	"votes": 0,
	"upvotes": [],
	"downvotes": [],
	"created_at": "2021-12-21T14:07:41.639121Z",
	"favorited": []
}

Edit Answer

Token authentication required, and must match the author of the answer. Body field required.

Request

PATCH /questions/10/answers/4/
{
	"body": "I think you fold it hamburger, not hot dog."
}

Response

{
	"pk": 4,
	"body": "I think you fold it hamburger, not hot dog.",
	"author": {
		"pk": 2,
		"username": "james"
	},
	"question": 10,
	"votes": 0,
	"upvotes": [],
	"downvotes": [],
	"created_at": "2021-12-21T14:07:41.639121Z",
	"favorited": []
}

Delete Answer

Token authentication required, and must match the author of the answer. Body should be empty.

Request

DELETE /questions/10/answers/4/

Response

204 No Content

Search Answers

Spaces in search term need to replaced by a +. Body should be empty.

Request

GET /answers?search=soak

Response

200 OK
[
	{
		"pk": 1,
		"body": "You should let it soak at least 30 minutes before you put it in the dishwasher.",
		"author": "james",
		"question": 9,
		"votes": 1,
		"created_at": "2021-12-15T00:19:28.001432Z",
		"favorited": []
	}
]

Update Answer's Favorited Field

Token authentication required. If User has already favorited the answer, their pk will be removed from the Favorited field.

Request

PATCH /questions/9/answers/2/
{
	"favorited": []
}

Response

200 OK
{
	"pk": 2,
	"body": "Is it non-stick?",
	"author": "thomas",
	"question": 9,
	"votes": 1,
	"created_at": "2021-12-15T00:19:51.903050Z",
	"favorited": [
		3
	]
}

Upvote Answer

Token authentication required. Field value should be an empty list (or array, for the Javascript-inclined).

Request

PATCH /questions/9/answers/1/
{
	"upvotes": []
}

Response

200 OK
{
	"pk": 1,
	"body": "You should let it soak at least 30 minutes before you put it in the dishwasher.",
	"author": "james",
	"question": 9,
	"votes": 1,
	"upvotes": [
		1
	],
	"downvotes": [],
	"created_at": "2021-12-15T00:19:28.001432Z",
	"favorited": [
		1,
		2
	]
}

Downvote Answer

Token authentication required. Field value should be an empty list (or array, for the Javascript-inclined).

Request

PATCH /questions/9/answers/1/
{
	"downvotes": []
}

Response

200 OK
{
	"pk": 1,
	"body": "You should let it soak at least 30 minutes before you put it in the dishwasher.",
	"author": "james",
	"question": 9,
	"votes": -1,
	"upvotes": [],
	"downvotes": [
		3
	],
	"created_at": "2021-12-15T00:19:28.001432Z",
	"favorited": [
		1,
		2
	]
}

Tags

Token authentication required.

GET Request

GET /tags/
{
  
}

Response

200 OK
[
  {
    "pk": 1,
    "name": "Baking",
    "slug": "baking"
  },
  {
    "pk": 2,
    "name": "Butchery",
    "slug": "butchery"
  },
  {
    "pk": 3,
    "name": "Seafood",
    "slug": "seafood"
  },
  {
    "pk": 4,
    "name": "Smoking",
    "slug": "smoking"
  },
  {
    "pk": 5,
    "name": "Vegetables",
    "slug": "vegetables"
  }
]

POST Request

POST /tags/
{
  "name": "Fruit"
}

Response

201 Created
{
  "pk": 6,
  "name": "Fruit",
  "slug": "fruit"
}