diff options
| author | Joas Schilling <coding@schilljs.com> | 2022-07-01 10:50:31 +0200 |
|---|---|---|
| committer | Joas Schilling <coding@schilljs.com> | 2022-07-01 17:29:26 +0200 |
| commit | 229103dcd0b9bfa4353c3caaea4a5a2857f3b8ec (patch) | |
| tree | b428a9208d431d9c4477c1327cbec7cbe8337d60 /docs | |
| parent | eb6d6c4968e258364be500b7023890e033691744 (diff) | |
Add json note
Signed-off-by: Joas Schilling <coding@schilljs.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/chat.md | 6 | ||||
| -rw-r--r-- | docs/conversation.md | 6 | ||||
| -rw-r--r-- | docs/poll.md | 6 |
3 files changed, 18 insertions, 0 deletions
diff --git a/docs/chat.md b/docs/chat.md index 711dda709..5c843e059 100644 --- a/docs/chat.md +++ b/docs/chat.md @@ -4,6 +4,12 @@ Base endpoint is: `/ocs/v2.php/apps/spreed/api/v1`: since Nextcloud 13 ## Receive chat messages of a conversation +!!! note + + Due to the structure of the `lastMessage.reactions` array the response is not valid in XML. + It is therefor recommended to use `format=json` or send the `Content-Type: application/json` header, + to receive a JSON response. + * Method: `GET` * Endpoint: `/chat/{token}` * Data: diff --git a/docs/conversation.md b/docs/conversation.md index 5e668207c..1b2a12d9f 100644 --- a/docs/conversation.md +++ b/docs/conversation.md @@ -7,6 +7,12 @@ ## Get user´s conversations +!!! note + + Due to the structure of the `lastMessage.reactions` array the response is not valid in XML. + It is therefor recommended to use `format=json` or send the `Content-Type: application/json` header, + to receive a JSON response. + * Method: `GET` * Endpoint: `/room` * Data: diff --git a/docs/poll.md b/docs/poll.md index 8b78f634e..43b3cd210 100644 --- a/docs/poll.md +++ b/docs/poll.md @@ -88,6 +88,12 @@ Base endpoint is: `/ocs/v2.php/apps/spreed/api/v1` ## Poll data +!!! note + + Due to the structure of the `votes` array the response is not valid in XML. + It is therefor recommended to use `format=json` or send the `Content-Type: application/json` header, + to receive a JSON response. + | field | type | Description | |--------------------|----------|-----------------------------------------------------------------------------------------------------------------------------------| | `id` | int | ID of the poll | |