Skip to content

Mention /api/v1 URL prefix in the documentation #35

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.

Sign up for GitHub

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

Merged
nodiscc merged 1 commit into from
Jul 18, 2018
Merged

Mention /api/v1 URL prefix in the documentation #35

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 3 additions & 0 deletions api-documentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ This documentation is written according to [API Blueprint specification](https:/
* HTML version: https://shaarli.github.io/api-documentation/
* Git repository: https://github.com/shaarli/api-documentation

All endpoints described in this documentation must be prefixed with `/api/v1/`.
Example: `GET http://shaarli.domain.tld/api/v1/info`

> Note: all requests reaching described services must include a valid JWT token in the HTTP header. The signature must use SHA512 encryption algorithm.
>
> The header must have use the following syntax:
Expand Down