API docs by Redocly

Notes API (1.0.0)

Download OpenAPI specification:Download

Login user

Request Body schema: application/json

User object

email
string
password
string

Responses

Request samples

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

Response samples

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

Register user

Request Body schema: application/json

User object

email
string
password
string

Responses

Request samples

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

Response samples

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

Create new category

Authorizations:
BearerAuth
Request Body schema: application/json

Category object

name
string

Responses

Request samples

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

Response samples

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

Edit category

Authorizations:
BearerAuth
path Parameters
categoryId
required
string

Category id

Request Body schema: application/json

Category object

name
string

Responses

Request samples

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

Response samples

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

Delete category

Authorizations:
BearerAuth
path Parameters
categoryId
required
string

Category id

Responses

Response samples

Content type
application/json
{ }

Get notes

Authorizations:
BearerAuth
query Parameters
fields
Array of strings

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create notes

Authorizations:
BearerAuth
Request Body schema: application/json

Note object

title
string
content
string
image
string
category
string

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "content": "string",
  • "image": "string",
  • "category": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "title": "string",
  • "content": "string",
  • "image": "string",
  • "public": true,
  • "category": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "user": "string"
}

Get note

Authorizations:
BearerAuth
path Parameters
noteId
required
string

Note id

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "title": "string",
  • "content": "string",
  • "image": "string",
  • "public": true,
  • "category": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "user": "string"
}

Edit note

Authorizations:
BearerAuth
path Parameters
noteId
required
string

Note id

Request Body schema: application/json

Note object

title
string
content
string
image
string
category
string
public
boolean

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "content": "string",
  • "image": "string",
  • "category": "string",
  • "public": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "title": "string",
  • "content": "string",
  • "image": "string",
  • "public": true,
  • "category": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "user": "string"
}

Delete note

Authorizations:
BearerAuth
path Parameters
noteId
required
string

Note id

Responses

Response samples

Content type
application/json
{ }

Get public Note

path Parameters
noteId
required
string

Note id

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "title": "string",
  • "content": "string",
  • "image": "string",
  • "public": true,
  • "category": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "user": "string"
}

Upload image for a note

Authorizations:
BearerAuth
path Parameters
noteId
required
string

Note id

Request Body schema: multipart/form-data
image
string <binary>

Responses

Response samples

Content type
application/json
{ }