liz/PluralKit
liz/PluralKit
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fix(docs): misc api fixes

Browse Source
This commit is contained in:
spiral 2022-11-03 22:51:18 +00:00
parent 44efc15b90
commit 88acb70243
No known key found for this signature in database
GPG Key ID: 244A11E4B0BCF40E
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/content/api/models.md
View File

@ -22,14 +22,14 @@ Every PluralKit entity has two IDs: a short (5-character) ID and a longer UUID.
|---|---|---| |---|---|---|
|id|string|| |id|string||
|uuid|string|| |uuid|string||
|name|string|100-character limit| |name|?string|100-character limit|
|description|?string|1000-character limit| |description|?string|1000-character limit|
|tag|string|| |tag|?string||
|pronouns|?string|100-character limit| |pronouns|?string|100-character limit|
|avatar_url|?string|256-character limit, must be a publicly-accessible URL| |avatar_url|?string|256-character limit, must be a publicly-accessible URL|
|banner|?string|256-character limit, must be a publicly-accessible URL| |banner|?string|256-character limit, must be a publicly-accessible URL|
|color|string|6-character hex code, no `#` at the beginning| |color|?string|6-character hex code, no `#` at the beginning|
|created|datetime|| |created|?datetime||
|privacy|?system privacy object|| |privacy|?system privacy object||
* System privacy keys: `description_privacy`, `pronoun_privacy`, `member_list_privacy`, `group_list_privacy`, `front_privacy`, `front_history_privacy` * System privacy keys: `description_privacy`, `pronoun_privacy`, `member_list_privacy`, `group_list_privacy`, `front_privacy`, `front_history_privacy`
@ -42,7 +42,7 @@ Every PluralKit entity has two IDs: a short (5-character) ID and a longer UUID.
|uuid|string|| |uuid|string||
|name|string|100-character limit| |name|string|100-character limit|
|display_name|?string|100-character limit| |display_name|?string|100-character limit|
|color|string|6-character hex code, no `#` at the beginning| |color|?string|6-character hex code, no `#` at the beginning|
|birthday|?string|`YYYY-MM-DD` format, 0004 hides the year| |birthday|?string|`YYYY-MM-DD` format, 0004 hides the year|
|pronouns|?string|100-character-limit| |pronouns|?string|100-character-limit|
|avatar_url|?string|256-character limit, must be a publicly-accessible URL| |avatar_url|?string|256-character limit, must be a publicly-accessible URL|
@ -75,7 +75,7 @@ Every PluralKit entity has two IDs: a short (5-character) ID and a longer UUID.
|description|?string|1000-character limit| |description|?string|1000-character limit|
|icon|?string|256-character limit, must be a publicly-accessible URL| |icon|?string|256-character limit, must be a publicly-accessible URL|
|banner|?string|256-character limit, must be a publicly-accessible URL| |banner|?string|256-character limit, must be a publicly-accessible URL|
|color|string|6-character hex code, no `#` at the beginning| |color|?string|6-character hex code, no `#` at the beginning|
|privacy|?group privacy object|| |privacy|?group privacy object||
* Group privacy keys: `name_privacy`, `description_privacy`, `icon_privacy`, `list_privacy`, `metadata_privacy`, `visibility` * Group privacy keys: `name_privacy`, `description_privacy`, `icon_privacy`, `list_privacy`, `metadata_privacy`, `visibility`
@ -120,7 +120,7 @@ Every PluralKit entity has two IDs: a short (5-character) ID and a longer UUID.
|key|type|notes| |key|type|notes|
|---|---|---| |---|---|---|
|guild_id|snowflake|only sent if the guild ID isn't already known (in dispatch payloads)| |?guild_id|snowflake|only sent if the guild ID isn't already known (in dispatch payloads)|
|proxying_enabled|boolean|| |proxying_enabled|boolean||
|tag|?string|79-character limit| |tag|?string|79-character limit|
|tag_enabled|boolean|| |tag_enabled|boolean||