-
Notifications
You must be signed in to change notification settings - Fork 447
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add documentation for the settings api
Signed-off-by: Joas Schilling <coding@schilljs.com>
- Loading branch information
1 parent
fb7557e
commit ce2f71a
Showing
2 changed files
with
27 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters