From e330678a055586b04ceb21d17877735a3abb7912 Mon Sep 17 00:00:00 2001 From: krateng Date: Sat, 23 Apr 2022 15:45:32 +0200 Subject: [PATCH] Update API.md --- API.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/API.md b/API.md index deb7e88..5692116 100644 --- a/API.md +++ b/API.md @@ -57,6 +57,7 @@ No application should ever rely on the non-existence of fields in the JSON data ## General Structure + Most endpoints follow this structure: | Key | Type | Description | @@ -65,10 +66,11 @@ Most endpoints follow this structure: | `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! | | `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: - | Key | Type | Description | | --- | --- | --- | | `type` | String | Name of the error or warning type |