Skip to content

Commit

Permalink
Add documentation for the settings api
Browse files Browse the repository at this point in the history
Signed-off-by: Joas Schilling <coding@schilljs.com>
  • Loading branch information
nickvergessen committed May 7, 2020
1 parent fb7557e commit ce2f71a
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 0 deletions.
26 changes: 26 additions & 0 deletions docs/settings.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Settings API

* Base endpoint: `/ocs/v2.php/apps/spreed/api/v1`

## Set user´s settings

* Method: `POST`
* Endpoint: `/settings/user`
* Data:

field | type | Description
------|------|------------
`key` | string | The user config to set
`value` | string | The value to set

* Response:
- Header:
+ `200 OK` When the value was updated
+ `400 Bad Request` When the key or value was invalid
+ `401 Unauthorized` When the user is not logged in

## User settings

Key | Capability | Default | Valid values
----|------------|---------|-------------
`attachment_folder` | `config => attachments => folder` | `/Talk` | Path owned by the user to store uploads and received shares. It is created if it does not exist.
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ nav:
- 'Call management': 'call.md'
- 'Chat management': 'chat.md'
- 'Webinar management': 'webinar.md'
- 'Settings': 'settings.md'
- 'Integration by other apps': 'integration.md'
- 'Internal signaling API': 'internal-signaling.md'
- 'External signaling API': 'standalone-signaling-api-v1.md'
Expand Down

0 comments on commit ce2f71a

Please sign in to comment.