Skip to content

Commit

Permalink
Documentation - REST API - Mention dev.debug mode
Browse files Browse the repository at this point in the history
  • Loading branch information
ArthurHoaro committed Jul 17, 2018
1 parent 5d32c50 commit 40f0ff2
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions doc/md/REST-API.md
Expand Up @@ -152,3 +152,22 @@ See the reference API client:

- [Documentation](http://python-shaarli-client.readthedocs.io/en/latest/) on ReadTheDocs
- [python-shaarli-client](https://github.com/shaarli/python-shaarli-client) on Github

## Troubleshooting

### Debug mode

> This should never be used in a production environment.
For security reasons, authentication issues will always return an `HTTP 401` error code without any detail.

It is possible to enable the debug mode in `config.json.php`
to get the actual error message in the HTTP response body with:

```json
{
"dev": {
"debug": true
}
}
```

0 comments on commit 40f0ff2

Please sign in to comment.