From 56156fe7f38d2468d958a8cc8544217e7f24a4f5 Mon Sep 17 00:00:00 2001 From: ArthurHoaro Date: Tue, 17 Jul 2018 13:41:48 +0200 Subject: [PATCH] Mention /api/v1 URL prefix in the documentation --- api-documentation.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/api-documentation.md b/api-documentation.md index 3a7c729..d710896 100644 --- a/api-documentation.md +++ b/api-documentation.md @@ -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: