API docs by Redocly

Conduit API (1.0.0)

Download OpenAPI specification:Download

URL: http://localhost:8080 License: MIT License

Conduit API documentation

Articles

Get recent articles from users you follow

Get most recent articles from users you follow. Use query parameters to limit. Auth is required

Authorizations:
Token
query Parameters
offset
integer >= 0

The number of items to skip before starting to collect the result set.

limit
integer >= 1
Default: 20

The numbers of items to return.

Responses

Response samples

Content type
application/json
{
  • "articles": [
    ],
  • "articlesCount": 0
}

Get recent articles globally

Get most recent articles globally. Use query parameters to filter results. Auth is optional

query Parameters
tag
string

Filter by tag

author
string

Filter by author (username)

favorited
string

Filter by favorites of a user (username)

offset
integer >= 0

The number of items to skip before starting to collect the result set.

limit
integer >= 1
Default: 20

The numbers of items to return.

Responses

Response samples

Content type
application/json
{
  • "articles": [
    ],
  • "articlesCount": 0
}

Create an article

Create an article. Auth is required

Authorizations:
Token
Request Body schema: application/json

Article to create

required
object (NewArticle)

Responses

Request samples

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

Response samples

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

Get an article

Get an article. Auth not required

path Parameters
slug
required
string

Slug of the article to get

Responses

Response samples

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

Update an article

Update an article. Auth is required

Authorizations:
Token
path Parameters
slug
required
string

Slug of the article to update

Request Body schema: application/json

Article to update

required
object (UpdateArticle)

Responses

Request samples

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

Response samples

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

Delete an article

Delete an article. Auth is required

Authorizations:
Token
path Parameters
slug
required
string

Slug of the article to delete

Responses

Response samples

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

Comments

Get comments for an article

Get the comments for an article. Auth is optional

path Parameters
slug
required
string

Slug of the article that you want to get comments for

Responses

Response samples

Content type
application/json
{
  • "comments": [
    ]
}

Create a comment for an article

Create a comment for an article. Auth is required

Authorizations:
Token
path Parameters
slug
required
string

Slug of the article that you want to create a comment for

Request Body schema: application/json

Comment you want to create

required
object (NewComment)

Responses

Request samples

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

Response samples

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

Delete a comment for an article

Delete a comment for an article. Auth is required

Authorizations:
Token
path Parameters
slug
required
string

Slug of the article that you want to delete a comment for

id
required
integer

ID of the comment you want to delete

Responses

Response samples

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

Favorites

Favorite an article

Favorite an article. Auth is required

Authorizations:
Token
path Parameters
slug
required
string

Slug of the article that you want to favorite

Responses

Response samples

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

Unfavorite an article

Unfavorite an article. Auth is required

Authorizations:
Token
path Parameters
slug
required
string

Slug of the article that you want to unfavorite

Responses

Response samples

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

Profile

Get a profile

Get a profile of a user of the system. Auth is optional

path Parameters
username
required
string

Username of the profile to get

Responses

Response samples

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

Follow a user

Follow a user by username

Authorizations:
Token
path Parameters
username
required
string

Username of the profile you want to follow

Responses

Response samples

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

Unfollow a user

Unfollow a user by username

Authorizations:
Token
path Parameters
username
required
string

Username of the profile you want to unfollow

Responses

Response samples

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

Tags

Get tags

Get tags. Auth not required

Responses

Response samples

Content type
application/json
{
  • "tags": [
    ]
}

User and Authentication

Existing user login

Login for existing user

Request Body schema: application/json

Credentials to use

required
object (LoginUser)

Responses

Request samples

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

Response samples

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

CreateUser

Register a new user

Request Body schema: application/json

Details of the new user to register

required
object (NewUser)

Responses

Request samples

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

Response samples

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

Get current user

Gets the currently logged-in user

Authorizations:
Token

Responses

Response samples

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

Update current user

Updated user information for current user

Authorizations:
Token
Request Body schema: application/json

User details to update. At least one field is required.

required
object (UpdateUser)

Responses

Request samples

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

Response samples

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