Subtitles API (1.0.0)

Download OpenAPI specification:

REST API for the Subtitles application

Register a new user.

Register a new user.

Request Body schema: application/json
required
email
required
string <email>
password
required
string >= 8 characters

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "password": "password123"
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get a new token.

Get a new token.

Request Body schema: application/json
required
email
required
string <email>
password
required
string >= 8 characters

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "password": "password123"
}

Response samples

Content type
application/json
{
  • "access": "string",
  • "refresh": "string",
  • "email": "user@example.com"
}

Refresh a token.

Refresh a token.

Request Body schema: application/json
required
refresh
string

Responses

Request samples

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

Response samples

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

Returns a list of history sets.

Returns a list of history sets.

query Parameters
limit
integer
Default: 10

Number of items to return

offset
integer
Default: 0

Offset for pagination

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "string",
  • "previous": "string",
  • "results": [
    ]
}

Create a new history set.

Create a new history set.

Request Body schema: application/json
required
title
required
string

Responses

Request samples

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

Response samples

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

Returns a history set.

Returns a history set.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "title": "string",
  • "created_at": "string",
  • "updated_at": "string"
}

Update a history set.

Update a history set.

Request Body schema: application/json
required
title
required
string

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "error": {
    }
}

Delete a history set.

Delete a history set.

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Returns a list of history.

Returns a list of history.

query Parameters
limit
integer
Default: 10

Number of items to return

offset
integer
Default: 0

Offset for pagination

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "string",
  • "previous": "string",
  • "results": [
    ]
}

Returns a list of history.

Optional extended description in CommonMark or HTML.

Request Body schema: application/json
required
content
string

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "error": {
    }
}

Check if the server is live.

Check if the server is live.

Responses

Response samples

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

Check if the server is ready.

Check if the server is ready.

Responses

Response samples

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