diff options
| author | Joas Schilling <coding@schilljs.com> | 2020-05-07 15:45:24 +0300 |
|---|---|---|
| committer | Joas Schilling <coding@schilljs.com> | 2020-05-07 15:47:28 +0300 |
| commit | ce2f71ad0937044f726305df2f659eb664181b14 (patch) | |
| tree | 5bc6a4d7991d5e089756e203645320ac432149c3 /docs | |
| parent | fb7557e23ffddedcf142ed50200e262f4c1b9094 (diff) | |
Add documentation for the settings api
Signed-off-by: Joas Schilling <coding@schilljs.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/settings.md | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/docs/settings.md b/docs/settings.md new file mode 100644 index 000000000..3faaf0b28 --- /dev/null +++ b/docs/settings.md @@ -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. |