add user config api docs

This commit is contained in:
Simon 2023-11-01 22:58:07 +07:00
parent 7386eec166
commit 5d6db7a4f1
2 changed files with 19 additions and 0 deletions

18
mkdocs/docs/api/config.md Normal file
View 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
}
```

View File

@ -39,6 +39,7 @@ nav:
- 'Backup': 'api/backup.md'
- 'Task': 'api/task.md'
- 'Stats': 'api/stats.md'
- 'Config': 'api/config.md'
- 'Additional': 'api/additional.md'
- Links:
- 'Main site': https://www.tubearchivist.com