API docs by Redocly

Apodeixis backend (0.1.0)

Download OpenAPI specification:Download

License: MIT

Auth

Login user.

Request Body schema: application/vnd.api+json
required
required
object (LoginUser)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "included": [
    ]
}

Logout user.

Invalidate refresh token.

Authorizations:
bearerAuth
Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "errors": [
    ]
}

OAuth2

Generate URL for Google OAuth2 sign in.

Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Callback from sign in with Google.

Sign Up/Login user via Google.

Request Body schema: application/json
required
required
object (OAuth2Callback)

Responses

Request samples

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

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "included": [
    ]
}

Recover Password

Recover password.

Recover password using password recovery token.

Request Body schema: application/json
required
required
object (RecoverPassword)

Responses

Request samples

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

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Send password recovery email.

Request Body schema: application/vnd.api+json
required
required
object (Email)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Refresh

Refresh token

Extracts refresh token from cookie and in case it exists and is legit, rotates it and creates access token.

Authorizations:
refreshTokenCookie
Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Sign Up

Sign up user.

Request Body schema: application/vnd.api+json
required
required
object (SignUpUser)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Verify email

Verify email when user clicks on link in verification email.

Request Body schema: application/json
required
required
object (EmailToken)

Responses

Request samples

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

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Send verification email.

Request Body schema: application/vnd.api+json
required
required
object (Email)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Posts

Create post.

Authorizations:
bearerAuth
Request Body schema: application/json
required
required
object (CreatePost)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "data": {
    },
  • "included": [
    ]
}

Get post.

path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "included": [
    ]
}

Get posts amount.

Responses

Response samples

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

Get confirmed posts headers.

query Parameters
limit
integer >= 1
Default: 15
cursor
integer >= 0
Default: 2147483647
sorting
string
Default: "desc"
Enum: "asc" "desc"
author[id]
integer >= 1

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "included": [
    ]
}

Get user's posts headers.

Authorizations:
bearerAuth
query Parameters
limit
integer >= 1
Default: 15
cursor
integer >= 0
Default: 2147483647
sorting
string
Default: "desc"
Enum: "asc" "desc"
post[status]
string
Default: "confirmed"
Enum: "new" "pending" "confirmed" "failed"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "included": [
    ]
}

Edit

Edit profile info of the user.

Authorizations:
bearerAuth
Request Body schema: application/vnd.api+json
required
object (EditUser)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "included": [
    ]
}

User

Create starred post.

Authorizations:
bearerAuth
Request Body schema: application/json
required
required
object (PostKey)

Responses

Request samples

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

Response samples

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

Delete post from starred.

Authorizations:
bearerAuth
path Parameters
id
required
integer

Responses

Response samples

Content type
application/vnd.api+json
{
  • "errors": [
    ]
}

Get user's starred posts headers.

Authorizations:
bearerAuth
query Parameters
limit
integer >= 1
Default: 15
cursor
integer >= 0
Default: 2147483647
sorting
string
Default: "desc"
Enum: "asc" "desc"
author[id]
integer >= 1

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "included": [
    ]
}

Users

Get user.

path Parameters
id
required
integer

Responses

Response samples

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