simple-login/app
1
1
Fork 0
mirror of https://github.com/simple-login/app.git synced 2025-02-20 22:02:54 +08:00
Code Issues Projects Releases Packages Wiki Activity

Fix readme: "error" could be shown to user as-is

Browse source
This commit is contained in:
Son NK 2020-01-05 21:09:54 +01:00
parent d322d543af
commit deba806d0f
1 changed files with 10 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -432,10 +432,15 @@ In every request, the extension sends
If error, the API returns 4** with body containing the error message, for example:
```json
{"error": "request body cannot be empty"}
{
"error": "request body cannot be empty"
}
```
The error message is used mostly for debugging and should never be displayed to user as-is.
The error message could be displayed to user as-is, for example for when user exceeds their alias quota.
Some errors should be fixed during development however: for example error like `request body cannot be empty` is there to catch development error and should never be shown to user.
All following endpoint return `401` status code if the API Key is incorrect.
#### GET /api/v2/alias/options
@ -490,7 +495,9 @@ Output:
If success, 201 with the new alias, for example
```json
{alias: "www_groupon_com@my_domain.com"}
{
"alias": "www_groupon_com@my_domain.com"
}
```
409 if the alias is already created.