aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/md/REST-API.md
diff options
context:
space:
mode:
authornodiscc <nodiscc@gmail.com>2018-07-18 14:19:51 +0200
committerGitHub <noreply@github.com>2018-07-18 14:19:51 +0200
commitd6e392a9cb5f3929e5a5d0821efcf404f51b3620 (patch)
treee6b3aeee033add17d3b29907deefa153397bd587 /doc/md/REST-API.md
parent5d32c50ad70a659a6c86b80fa65d7ec41e045b1e (diff)
parent40f0ff2236a92e2f2fb1631d1ffe62c56d5425ed (diff)
downloadShaarli-d6e392a9cb5f3929e5a5d0821efcf404f51b3620.tar.gz
Shaarli-d6e392a9cb5f3929e5a5d0821efcf404f51b3620.tar.zst
Shaarli-d6e392a9cb5f3929e5a5d0821efcf404f51b3620.zip
Merge pull request #1181 from ArthurHoaro/docs/api-debug
Documentation - REST API - Mention dev.debug mode
Diffstat (limited to 'doc/md/REST-API.md')
-rw-r--r--doc/md/REST-API.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/doc/md/REST-API.md b/doc/md/REST-API.md
index c016de56..11bd1cd2 100644
--- a/doc/md/REST-API.md
+++ b/doc/md/REST-API.md
@@ -152,3 +152,22 @@ See the reference API client:
152 152
153- [Documentation](http://python-shaarli-client.readthedocs.io/en/latest/) on ReadTheDocs 153- [Documentation](http://python-shaarli-client.readthedocs.io/en/latest/) on ReadTheDocs
154- [python-shaarli-client](https://github.com/shaarli/python-shaarli-client) on Github 154- [python-shaarli-client](https://github.com/shaarli/python-shaarli-client) on Github
155
156## Troubleshooting
157
158### Debug mode
159
160> This should never be used in a production environment.
161
162For security reasons, authentication issues will always return an `HTTP 401` error code without any detail.
163
164It is possible to enable the debug mode in `config.json.php`
165to get the actual error message in the HTTP response body with:
166
167```json
168{
169 "dev": {
170 "debug": true
171 }
172}
173```