From 15966946860947ab195232d91e4e29af779ea912 Mon Sep 17 00:00:00 2001 From: Grey Himmel Date: Fri, 9 Aug 2019 11:40:58 -0400 Subject: [PATCH] Document member display names --- docs/3-api-documentation.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/3-api-documentation.md b/docs/3-api-documentation.md index 8644eac5..a9898b04 100644 --- a/docs/3-api-documentation.md +++ b/docs/3-api-documentation.md @@ -38,6 +38,7 @@ The following three models (usually represented in JSON format) represent the va |---|---|---|---| |id|string|No|| |name|string?|Yes|50-character limit.| +|display name|string?|Yes|50-character limit.| |description|string?|Yes|1000-character limit.| |color|color?|Yes|6-char hex (eg. `ff7000`), sans `#`.| |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 { "name": "Craig Peterson", + "display_name": "Craig Peterson [he/they]", "color": null, "avatar_url": "https://path/to/new/image.png", "birthday": "1997-07-14", @@ -278,6 +280,7 @@ Creates a new member with the information given. Missing fields (except for name { "id": "qwert", "name": "Craig Peterson", + "display_name": "Craig Peterson [he/they]", "color": null, "avatar_url": "https://path/to/new/image.png", "birthday": "1997-07-14", @@ -300,6 +303,7 @@ Edits a member's information. Missing fields will be set to `null`. Will return ```json { "name": "Craig Peterson", + "display_name": "Craig Peterson [he/they]", "color": null, "avatar_url": "https://path/to/new/image.png", "birthday": "1997-07-14", @@ -315,6 +319,7 @@ Edits a member's information. Missing fields will be set to `null`. Will return { "id": "qwert", "name": "Craig Peterson", + "display_name": "Craig Peterson [he/they]", "color": null, "avatar_url": "https://path/to/new/image.png", "birthday": "1997-07-14",