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

feat(docs): document 'system' key in member/group models

Browse source
This commit is contained in:
alyssa 2024-05-03 01:18:15 +09:00
parent 5656f592a9
commit 73f43b8cb3
1 changed files with 2 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -40,6 +40,7 @@ Every PluralKit entity has two IDs: a short (5-character) ID and a longer UUID.
|---|---|---| |---|---|---|
|id|string|| |id|string||
|uuid|string|| |uuid|string||
|?system|string|id of system this member is registered in (only returned in `/members/:id` endpoint)|
|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|
@ -75,6 +76,7 @@ Every PluralKit entity has two IDs: a short (5-character) ID and a longer UUID.
|---|---|---| |---|---|---|
|id|string|| |id|string||
|uuid|string|| |uuid|string||
|?system|string|id of system this group is registered in (only returned in `/groups/:id` endpoint)|
|name|string|100-character limit| |name|string|100-character limit|
|display_name|?string|100-character limit| |display_name|?string|100-character limit|
|description|?string|1000-character limit| |description|?string|1000-character limit|