From 58b5f0e62cb9e4474a6d2f73ae201f4c3af250e7 Mon Sep 17 00:00:00 2001 From: Amber Bertucci Date: Fri, 25 Nov 2022 18:56:36 +0100 Subject: [PATCH 1/3] Fix inconsistencies within the model docs - Make sure that the `?` character always appears at the beginning of the type. - Add a href to all the relational types - Use list instead of array everywhere - Explicit the `/` as or - Normalize the format of relational types --- docs/content/api/models.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/content/api/models.md b/docs/content/api/models.md index a0a41e27..9878e863 100644 --- a/docs/content/api/models.md +++ b/docs/content/api/models.md @@ -49,7 +49,7 @@ Every PluralKit entity has two IDs: a short (5-character) ID and a longer UUID. |banner|?string|256-character limit, must be a publicly-accessible URL| |description|?string|1000-character limit| |created|?datetime|| -|proxy_tags|array of [ProxyTag objects](#proxytag-object)| +|proxy_tags|list of [ProxyTag](#proxytag-object) objects| |keep_proxy|boolean|| |privacy|?member privacy object|| @@ -86,7 +86,7 @@ Every PluralKit entity has two IDs: a short (5-character) ID and a longer UUID. |---|---|---| |id|uuid|| |timestamp|datetime|| -| members | list of id/Member | Is sometimes in plain ID list form (eg. `GET /systems/:id/switches`), sometimes includes the full Member model (eg. `GET /systems/:id/fronters`). | +| members | list of id or [Member](#member-model) | Is sometimes in plain ID list form (eg. `GET /systems/:id/switches`), sometimes includes the full Member model (eg. `GET /systems/:id/fronters`). | ### Message model @@ -98,8 +98,8 @@ Every PluralKit entity has two IDs: a short (5-character) ID and a longer UUID. |sender|snowflake|The user ID of the account that triggered the proxy. Encoded as string for precision reasons.| |channel|snowflake|The ID of the channel the message was sent in. Encoded as string for precision reasons.| |guild|snowflake|The ID of the server the message was sent in. Encoded as string for precision reasons.| -|system?|full System object|The system that proxied the message. Null if the member associated with this message was deleted.| -|member?|full Member object|The member that proxied the message. Null if the member associated with this message was deleted.| +|system|?full [System](#system-model) object|The system that proxied the message. Null if the member associated with this message was deleted.| +|member|?full [Member](#member-model) object|The member that proxied the message. Null if the member associated with this message was deleted.| ### System settings model @@ -107,7 +107,7 @@ Every PluralKit entity has two IDs: a short (5-character) ID and a longer UUID. |---|---|---| |timezone|string|defaults to `UTC`| |pings_enabled|boolean| -|latch_timeout|int?| +|latch_timeout|?int| |member_default_private*|boolean|whether members created through the bot have privacy settings set to private by default| |group_default_private*|boolean|whether groups created through the bot have privacy settings set to private by default| |show_private_info|boolean|whether the bot shows the system's own private information without a `-private` flag| @@ -120,7 +120,7 @@ Every PluralKit entity has two IDs: a short (5-character) ID and a longer UUID. |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|| |tag|?string|79-character limit| |tag_enabled|boolean|| @@ -129,7 +129,7 @@ Every PluralKit entity has two IDs: a short (5-character) ID and a longer UUID. ### Autoproxy settings model |key|type|notes| |---|---|---| -|autoproxy_mode|[autoproxy mode](#autoproxy-mode-enum)|| +|autoproxy_mode|[Autoproxy mode](#autoproxy-mode-enum) enum|| |autoproxy_member|?member id|must be `null` if autoproxy_mode is set to `front`| |last_latch_timestamp|?datetime|read-only| @@ -146,6 +146,6 @@ Every PluralKit entity has two IDs: a short (5-character) ID and a longer UUID. |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)| |display_name|?string|100-character limit| |avatar_url|?string|256-character limit, must be a publicly-accessible URL| From a00793b70a6c49b572ec4443600c35d810da8956 Mon Sep 17 00:00:00 2001 From: Amber Bertucci Date: Fri, 25 Nov 2022 19:10:34 +0100 Subject: [PATCH 2/3] Model docs: list -> array --- docs/content/api/models.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/content/api/models.md b/docs/content/api/models.md index 9878e863..e785f2d2 100644 --- a/docs/content/api/models.md +++ b/docs/content/api/models.md @@ -49,7 +49,7 @@ Every PluralKit entity has two IDs: a short (5-character) ID and a longer UUID. |banner|?string|256-character limit, must be a publicly-accessible URL| |description|?string|1000-character limit| |created|?datetime|| -|proxy_tags|list of [ProxyTag](#proxytag-object) objects| +|proxy_tags|array of [ProxyTag](#proxytag-object) objects| |keep_proxy|boolean|| |privacy|?member privacy object|| @@ -86,7 +86,7 @@ Every PluralKit entity has two IDs: a short (5-character) ID and a longer UUID. |---|---|---| |id|uuid|| |timestamp|datetime|| -| members | list of id or [Member](#member-model) | Is sometimes in plain ID list form (eg. `GET /systems/:id/switches`), sometimes includes the full Member model (eg. `GET /systems/:id/fronters`). | +| members | array of id or [Member](#member-model) | Is sometimes in plain ID list form (eg. `GET /systems/:id/switches`), sometimes includes the full Member model (eg. `GET /systems/:id/fronters`). | ### Message model From 2e01dbf0a6f8ab318a7a9df1e08d8cac91b0d892 Mon Sep 17 00:00:00 2001 From: Amber Bertucci Date: Fri, 25 Nov 2022 19:12:39 +0100 Subject: [PATCH 3/3] Model docs: remove "enum" and match array format --- docs/content/api/models.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/content/api/models.md b/docs/content/api/models.md index e785f2d2..1f819856 100644 --- a/docs/content/api/models.md +++ b/docs/content/api/models.md @@ -86,7 +86,7 @@ Every PluralKit entity has two IDs: a short (5-character) ID and a longer UUID. |---|---|---| |id|uuid|| |timestamp|datetime|| -| members | array of id or [Member](#member-model) | Is sometimes in plain ID list form (eg. `GET /systems/:id/switches`), sometimes includes the full Member model (eg. `GET /systems/:id/fronters`). | +| members | array of id or [Member](#member-model) objects | Is sometimes in plain ID list form (eg. `GET /systems/:id/switches`), sometimes includes the full Member model (eg. `GET /systems/:id/fronters`). | ### Message model @@ -129,7 +129,7 @@ Every PluralKit entity has two IDs: a short (5-character) ID and a longer UUID. ### Autoproxy settings model |key|type|notes| |---|---|---| -|autoproxy_mode|[Autoproxy mode](#autoproxy-mode-enum) enum|| +|autoproxy_mode|[Autoproxy mode](#autoproxy-mode-enum)|| |autoproxy_member|?member id|must be `null` if autoproxy_mode is set to `front`| |last_latch_timestamp|?datetime|read-only|