Skip to content

chore(docs): Add 401 and 403 status code to API docs #5379

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/docs/ext/linter.py
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,7 @@ def line_length_checker(file):
# Ignore long lines with external links
continue

if line.endswith(">`_"):
if line.endswith(">`_") or line.endswith(">`"):
# Ignore long lines because of URLs
# TODO: need to be more smart here
continue
Expand Down
4 changes: 3 additions & 1 deletion src/docs/src/api/basics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -551,9 +551,11 @@ specific request types are provided in the corresponding API call reference.
The item requested was not available using the supplied authorization, or
authorization was not supplied.

.. _error/403:

- ``403 - Forbidden``

The requested item or operation is forbidden. This might be because;
The requested item or operation is forbidden. This might be because:

* Your user name or roles do not match the security object of the database
* The request requires administrator privileges but you don't have them
Expand Down
Loading