mirror/maloja
1
0
Fork 0
mirror of https://github.com/krateng/maloja.git synced 2023-08-10 21:12:55 +03:00
Code Issues Projects Releases Wiki Activity

Update API.md

Browse Source
This commit is contained in:
krateng 2022-04-23 15:45:32 +02:00 committed by GitHub
parent 0424fa7795
commit e330678a05
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
API.md
View File

@ -57,6 +57,7 @@ No application should ever rely on the non-existence of fields in the JSON data
## General Structure ## General Structure
Most endpoints follow this structure: Most endpoints follow this structure:
| Key | Type | Description | | Key | Type | Description |
@ -65,10 +66,11 @@ Most endpoints follow this structure:
| `error` | Mapping | Details about the error if one occured. | | `error` | Mapping | Details about the error if one occured. |
| `warnings` | List | Any warnings that did not result in failure, but should be noted. Field is omitted if there are no warnings! | | `warnings` | List | Any warnings that did not result in failure, but should be noted. Field is omitted if there are no warnings! |
| `desc` | String | Human-readable feedback. This can be shown directly to the user if desired. | | `desc` | String | Human-readable feedback. This can be shown directly to the user if desired. |
| `list` | List | List of returned [entities](#Entity-Structure) |
Both errors and warnings have the following structure: Both errors and warnings have the following structure:
| Key | Type | Description | | Key | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| `type` | String | Name of the error or warning type | | `type` | String | Name of the error or warning type |