API docs by Redocly

StoryBook API (1.0.0)

Download OpenAPI specification:Download

API Documentation for StoryBook

Register a new user

Request Body schema: application/json
username
string
password
string
email
string
first_name
string
last_name
string
dob
string <date>

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "string",
  • "email": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "dob": "2019-08-24"
}

Login a user

Request Body schema: application/json
username
string
password
string

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "token": "string"
}

Verify a user's email

query Parameters
code
required
string

Responses

Send a password reset email

Request Body schema: application/json
username
string

Responses

Request samples

Content type
application/json
{
  • "username": "string"
}

Reset a user's password

Request Body schema: application/json
password
string
code
string

Responses

Request samples

Content type
application/json
{
  • "password": "string",
  • "code": "string"
}

Retrieves all comments for a specific post

query Parameters
post
required
string

Responses

Add a comment to a post

Request Body schema: application/json
post
string
text
string

Responses

Request samples

Content type
application/json
{
  • "post": "string",
  • "text": "string"
}

Update a comment

Request Body schema: application/json
id
string
text
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "text": "string"
}

Delete a comment

Request Body schema: application/json
id
string

Responses

Request samples

Content type
application/json
{
  • "id": "string"
}

Retrieves all posts from users other than the logged in user

Responses

Retrieves a specific post by id

query Parameters
id
required
string

Responses

Create a new post

Request Body schema: application/json
text
string
image
string <binary>

Responses

Request samples

Content type
application/json
{
  • "text": "string",
  • "image": "string"
}

Update a post

Request Body schema: application/json
id
string
text
string
image
string <binary>

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "text": "string",
  • "image": "string"
}

Delete a post

Request Body schema: application/json
id
string

Responses

Request samples

Content type
application/json
{
  • "id": "string"
}

Retrieves the profile of the logged in user

Responses

Retrieves the profile of a specific user

Request Body schema: application/json
username
string

Responses

Request samples

Content type
application/json
{
  • "username": "string"
}

Update the profile of the logged in user

Request Body schema: application/json
first_name
string
last_name
string
dob
string <date>
bio
string
profile_picture
string <binary>

Responses

Request samples

Content type
application/json
{
  • "first_name": "string",
  • "last_name": "string",
  • "dob": "2019-08-24",
  • "bio": "string",
  • "profile_picture": "string"
}

Add a reaction to a post

Request Body schema: application/json
post
string

Responses

Request samples

Content type
application/json
{
  • "post": "string"
}

Remove a reaction from a post

Request Body schema: application/json
post
string

Responses

Request samples

Content type
application/json
{
  • "post": "string"
}