eightball/PluralKit
1
0
Fork 0
mirror of https://github.com/PluralKit/PluralKit.git synced 2026-02-17 03:00:13 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Model docs: remove "enum" and match array format

Browse source
This commit is contained in:
Amber Bertucci 2022-11-25 19:12:39 +01:00 • committed by GitHub
parent a00793b70a
commit 2e01dbf0a6
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

4
docs/content/api/models.md
View file

@ -86,7 +86,7 @@ Every PluralKit entity has two IDs: a short (5-character) ID and a longer UUID.
|---|---|---| |---|---|---|
|id|uuid|| |id|uuid||
|timestamp|datetime|| |timestamp|datetime||
| members | array of id or [Member](#member-model) | Is sometimes in plain ID list form (eg. `GET /systems/:id/switches`), sometimes includes the full Member model (eg. `GET /systems/:id/fronters`). | | members | array of id or [Member](#member-model) objects | Is sometimes in plain ID list form (eg. `GET /systems/:id/switches`), sometimes includes the full Member model (eg. `GET /systems/:id/fronters`). |
### Message model ### Message model
@ -129,7 +129,7 @@ Every PluralKit entity has two IDs: a short (5-character) ID and a longer UUID.
### Autoproxy settings model ### Autoproxy settings model
|key|type|notes| |key|type|notes|
|---|---|---| |---|---|---|
|autoproxy_mode|[Autoproxy mode](#autoproxy-mode-enum) enum|| |autoproxy_mode|[Autoproxy mode](#autoproxy-mode-enum)||
|autoproxy_member|?member id|must be `null` if autoproxy_mode is set to `front`| |autoproxy_member|?member id|must be `null` if autoproxy_mode is set to `front`|
|last_latch_timestamp|?datetime|read-only| |last_latch_timestamp|?datetime|read-only|