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

Document member display names

Browse Source
This commit is contained in:
Grey Himmel 2019-08-09 11:40:58 -04:00 committed by GitHub
parent d38c38cb9e
commit 1596694686
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/3-api-documentation.md
View File

@ -38,6 +38,7 @@ The following three models (usually represented in JSON format) represent the va
|---|---|---|---| |---|---|---|---|
|id|string|No|| |id|string|No||
|name|string?|Yes|50-character limit.| |name|string?|Yes|50-character limit.|
|display name|string?|Yes|50-character limit.|
|description|string?|Yes|1000-character limit.| |description|string?|Yes|1000-character limit.|
|color|color?|Yes|6-char hex (eg. `ff7000`), sans `#`.| |color|color?|Yes|6-char hex (eg. `ff7000`), sans `#`.|
|avatar_url|url?|Yes|Not validated server-side.| |avatar_url|url?|Yes|Not validated server-side.|
@ -263,6 +264,7 @@ Creates a new member with the information given. Missing fields (except for name
```json ```json
{ {
"name": "Craig Peterson", "name": "Craig Peterson",
"display_name": "Craig Peterson [he/they]",
"color": null, "color": null,
"avatar_url": "https://path/to/new/image.png", "avatar_url": "https://path/to/new/image.png",
"birthday": "1997-07-14", "birthday": "1997-07-14",
@ -278,6 +280,7 @@ Creates a new member with the information given. Missing fields (except for name
{ {
"id": "qwert", "id": "qwert",
"name": "Craig Peterson", "name": "Craig Peterson",
"display_name": "Craig Peterson [he/they]",
"color": null, "color": null,
"avatar_url": "https://path/to/new/image.png", "avatar_url": "https://path/to/new/image.png",
"birthday": "1997-07-14", "birthday": "1997-07-14",
@ -300,6 +303,7 @@ Edits a member's information. Missing fields will be set to `null`. Will return
```json ```json
{ {
"name": "Craig Peterson", "name": "Craig Peterson",
"display_name": "Craig Peterson [he/they]",
"color": null, "color": null,
"avatar_url": "https://path/to/new/image.png", "avatar_url": "https://path/to/new/image.png",
"birthday": "1997-07-14", "birthday": "1997-07-14",
@ -315,6 +319,7 @@ Edits a member's information. Missing fields will be set to `null`. Will return
{ {
"id": "qwert", "id": "qwert",
"name": "Craig Peterson", "name": "Craig Peterson",
"display_name": "Craig Peterson [he/they]",
"color": null, "color": null,
"avatar_url": "https://path/to/new/image.png", "avatar_url": "https://path/to/new/image.png",
"birthday": "1997-07-14", "birthday": "1997-07-14",