mirror of
https://github.com/tubearchivist/docs.git
synced 2024-11-14 16:10:12 +00:00
add user config api docs
This commit is contained in:
parent
7386eec166
commit
5d6db7a4f1
18
mkdocs/docs/api/config.md
Normal file
18
mkdocs/docs/api/config.md
Normal file
@ -0,0 +1,18 @@
|
|||||||
|
# Config
|
||||||
|
|
||||||
|
## User Config
|
||||||
|
Per user modified config values.
|
||||||
|
|
||||||
|
**GET** `/api/config/user/`
|
||||||
|
Return all config values *modified* by user.
|
||||||
|
|
||||||
|
**POST** `/api/config/user/`
|
||||||
|
Modify one or more config values. For possible key, values, see `UserConfig` class.
|
||||||
|
|
||||||
|
Example post data:
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"colors": "dark",
|
||||||
|
"page_size": 20
|
||||||
|
}
|
||||||
|
```
|
@ -39,6 +39,7 @@ nav:
|
|||||||
- 'Backup': 'api/backup.md'
|
- 'Backup': 'api/backup.md'
|
||||||
- 'Task': 'api/task.md'
|
- 'Task': 'api/task.md'
|
||||||
- 'Stats': 'api/stats.md'
|
- 'Stats': 'api/stats.md'
|
||||||
|
- 'Config': 'api/config.md'
|
||||||
- 'Additional': 'api/additional.md'
|
- 'Additional': 'api/additional.md'
|
||||||
- Links:
|
- Links:
|
||||||
- 'Main site': https://www.tubearchivist.com
|
- 'Main site': https://www.tubearchivist.com
|
||||||
|
Loading…
Reference in New Issue
Block a user