API Standard

V1 Endpoints

Authors

• GET /v1/authors returns a paginated list of all authors

  • Parameters
    • limit: int -- limits the results to the top n authors
    • offset: int
    • sort_by: string -- name
    • sort_direction: string -- asc, desc (alphabetic)
    • article_id: int -- search for an author by an article that they've written

• POST /v1/authors create new author object

• GET /v1/authors/{id} returns a specific author

• PUT /v1/authors/{id} replace author object

• PATCH /v1/authors/{id} update author object

• DELETE /v1/authors/{id} delete author object

• GET /v1/authors/{id}/articles returns a paginated list of articles written by an author with optional params

  • Parameters
    • limit: int -- limit the results to the top n articles
    • offset: int
    • section: string -- filter by section (includes all subsections)
    • subsection: string -- filter by subsection (takes precedence over section)
    • sort_by: string -- updated_at, published_at, title
    • sort_direction: string -- asc, desc
    • status: string -- draft, published

Articles

• GET /v1/articles returns a paginated list of articles with optional params
  • Parameters
    • limit: int -- limit the results to the top n articles
    • offset: int
    • section: string -- filter by section (includes all subsections)
    • subsection: string -- filter by subsection (takes precedence over section)
    • sort_by: string -- updated_at, published_at, title
    • sort_direction: string -- asc, desc
    • author_id: int -- filter by author
    • status: string -- draft, published
• GET /v1/articles/{id} get article object
• POST /v1/articles create article object
• PUT /v1/articles/{id} replace article object
• PATCH /v1/articles/{id} update article object
• DELETE /v1/articles/{id} delete article object

Media

Ignore this for now

Homepage