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

Attempt to fix table rendering on API docs

Browse Source
This commit is contained in:
Ske 2019-07-15 22:26:48 +02:00
parent b2ec1b6079
commit 8e592eea13
1 changed files with 16 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -22,31 +22,31 @@ The following three models (usually represented in JSON format) represent the va
### System model ### System model
|Key|Type|Patchable?|Notes| |Key|Type|Patchable?|Notes|
|---|---|---|---| |---|---|---|---|
|id|string|No| |id|string|No||
|name|string?|Yes|100-character limit. |name|string?|Yes|100-character limit.|
|description|string?|Yes|1000-character limit. |description|string?|Yes|1000-character limit.|
|tag|string?|Yes| |tag|string?|Yes||
|avatar_url|url?|Yes|Not validated server-side. |avatar_url|url?|Yes|Not validated server-side.|
|tz|string?|Yes|Tzdb identifier. Patching with `null` will store `"UTC"`. |tz|string?|Yes|Tzdb identifier. Patching with `null` will store `"UTC"`.|
|created|datetime|No| |created|datetime|No||
### Member model ### Member model
|Key|Type|Patchable?|Notes| |Key|Type|Patchable?|Notes|
|---|---|---|---| |---|---|---|---|
|id|string|No| |id|string|No||
|name|string?|Yes|50-character limit. |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.|
|birthday|date?|Yes|ISO-8601 (`YYYY-MM-DD`) format, year of `0001` means hidden year. |birthday|date?|Yes|ISO-8601 (`YYYY-MM-DD`) format, year of `0001` means hidden year.|
|prefix|string?|Yes|| |prefix|string?|Yes||
|suffix|string?|Yes|| |suffix|string?|Yes||
|created|datetime|No| |created|datetime|No||
### Switch model ### Switch model
|Key|Type|Notes| |Key|Type|Notes|
|---|---|---| |---|---|---|
|timestamp|datetime| |timestamp|datetime||
|members|list of id/Member|Is sometimes in plain ID list form (eg. `GET /s/<id>/switches`), sometimes includes the full Member model (eg. `GET /s/<id>/fronters`). |members|list of id/Member|Is sometimes in plain ID list form (eg. `GET /s/<id>/switches`), sometimes includes the full Member model (eg. `GET /s/<id>/fronters`).|
## Endpoints ## Endpoints