From 4ceb8630f0e0207c53298023042d509a5bd98f2b Mon Sep 17 00:00:00 2001 From: Mateo Date: Sat, 10 Sep 2022 21:30:34 -0500 Subject: [PATCH 1/6] add note about tags when modifying a forum channel: only name is required --- docs/resources/Channel.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/resources/Channel.md b/docs/resources/Channel.md index ba45d0fbb9..83b4a4418b 100644 --- a/docs/resources/Channel.md +++ b/docs/resources/Channel.md @@ -853,7 +853,7 @@ Requires the `MANAGE_CHANNELS` permission for the guild. Fires a [Channel Update | rtc_region | ?string | channel [voice region](#DOCS_RESOURCES_VOICE/voice-region-object) id, automatic when set to null | Voice, Stage | | video_quality_mode | ?integer | the camera [video quality mode](#DOCS_RESOURCES_CHANNEL/channel-object-video-quality-modes) of the voice channel | Voice | | default_auto_archive_duration | ?integer | the default duration that the clients use (not the API) for newly created threads in the channel, in minutes, to automatically archive the thread after recent activity | Text, Announcement, Forum | -| available_tags? | array of [tag](#DOCS_RESOURCES_CHANNEL/forum-tag-object) objects | the set of tags that can be used in a `GUILD_FORUM` channel | Forum | +| available_tags?\*\*\* | array of [tag](#DOCS_RESOURCES_CHANNEL/forum-tag-object) objects | the set of tags that can be used in a `GUILD_FORUM` channel | Forum | | default_reaction_emoji? | ?[default reaction](#DOCS_RESOURCES_CHANNEL/default-reaction-object) object | the emoji to show in the add reaction button on a thread in a `GUILD_FORUM` channel | Forum | | default_thread_rate_limit_per_user? | integer | the initial `rate_limit_per_user` to set on newly created threads in a channel. this field is copied to the thread at creation time and does not live update. | Text, Forum | @@ -861,6 +861,8 @@ Requires the `MANAGE_CHANNELS` permission for the guild. Fires a [Channel Update \*\* In each overwrite object, the `allow` and `deny` keys can be omitted or set to `null`, which both default to `"0"`. +\*\*\* For the new tags in a `GUILD_FORUM` channel, only `name` is required. + ###### JSON Params (Thread) When setting `archived` to `false`, when `locked` is also `false`, only the `SEND_MESSAGES` permission is required. From cbcf5a6c9ad0bd2e54cdc634959eb6242671dc55 Mon Sep 17 00:00:00 2001 From: Mateo Date: Wed, 14 Sep 2022 20:56:22 -0500 Subject: [PATCH 2/6] put this information in the tag object --- docs/resources/Channel.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/resources/Channel.md b/docs/resources/Channel.md index 83b4a4418b..cd2528858d 100644 --- a/docs/resources/Channel.md +++ b/docs/resources/Channel.md @@ -563,13 +563,15 @@ An object that represents a tag that is able to be applied to a thread in a `GUI | Field | Type | Description | | ---------- | --------- | -------------------------------------------------------------------------------------------------------------- | | id | snowflake | the id of the tag | -| name | string | the name of the tag (0-20 characters) | +| name\*\* | string | the name of the tag (0-20 characters) | | moderated | boolean | whether this tag can only be added to or removed from threads by a member with the `MANAGE_THREADS` permission | | emoji_id | snowflake | the id of a guild's custom emoji \* | | emoji_name | ?string | the unicode character of the emoji \* | \* At most one of `emoji_id` and `emoji_name` may be set. +\*\* If you are modifying a `GUILD_FORUM` channel with tags in `available_tags`, for the new ones added, only this field is required. + ### Embed Object ###### Embed Structure @@ -853,7 +855,7 @@ Requires the `MANAGE_CHANNELS` permission for the guild. Fires a [Channel Update | rtc_region | ?string | channel [voice region](#DOCS_RESOURCES_VOICE/voice-region-object) id, automatic when set to null | Voice, Stage | | video_quality_mode | ?integer | the camera [video quality mode](#DOCS_RESOURCES_CHANNEL/channel-object-video-quality-modes) of the voice channel | Voice | | default_auto_archive_duration | ?integer | the default duration that the clients use (not the API) for newly created threads in the channel, in minutes, to automatically archive the thread after recent activity | Text, Announcement, Forum | -| available_tags?\*\*\* | array of [tag](#DOCS_RESOURCES_CHANNEL/forum-tag-object) objects | the set of tags that can be used in a `GUILD_FORUM` channel | Forum | +| available_tags? | array of [tag](#DOCS_RESOURCES_CHANNEL/forum-tag-object) objects | the set of tags that can be used in a `GUILD_FORUM` channel | Forum | | default_reaction_emoji? | ?[default reaction](#DOCS_RESOURCES_CHANNEL/default-reaction-object) object | the emoji to show in the add reaction button on a thread in a `GUILD_FORUM` channel | Forum | | default_thread_rate_limit_per_user? | integer | the initial `rate_limit_per_user` to set on newly created threads in a channel. this field is copied to the thread at creation time and does not live update. | Text, Forum | @@ -861,8 +863,6 @@ Requires the `MANAGE_CHANNELS` permission for the guild. Fires a [Channel Update \*\* In each overwrite object, the `allow` and `deny` keys can be omitted or set to `null`, which both default to `"0"`. -\*\*\* For the new tags in a `GUILD_FORUM` channel, only `name` is required. - ###### JSON Params (Thread) When setting `archived` to `false`, when `locked` is also `false`, only the `SEND_MESSAGES` permission is required. From 27e03d135b05a35228f44f6218c78f92b4ce26f9 Mon Sep 17 00:00:00 2001 From: MateoDeveloper <79017590+Mateo-tem@users.noreply.github.com> Date: Wed, 14 Sep 2022 21:07:22 -0500 Subject: [PATCH 3/6] fix order error --- docs/resources/Channel.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/resources/Channel.md b/docs/resources/Channel.md index bb2c69bb35..409726a8c0 100644 --- a/docs/resources/Channel.md +++ b/docs/resources/Channel.md @@ -565,14 +565,14 @@ An object that represents a tag that is able to be applied to a thread in a `GUI | Field | Type | Description | | ---------- | --------- | -------------------------------------------------------------------------------------------------------------- | | id | snowflake | the id of the tag | -| name\*\* | string | the name of the tag (0-20 characters) | +| name \* | string | the name of the tag (0-20 characters) | | moderated | boolean | whether this tag can only be added to or removed from threads by a member with the `MANAGE_THREADS` permission | -| emoji_id | snowflake | the id of a guild's custom emoji \* | -| emoji_name | ?string | the unicode character of the emoji \* | +| emoji_id | snowflake | the id of a guild's custom emoji \*\* | +| emoji_name | ?string | the unicode character of the emoji \*\* | -\* At most one of `emoji_id` and `emoji_name` may be set. +\* If you are modifying a `GUILD_FORUM` channel with tags in `available_tags`, for the new ones added, only this field is required. -\*\* If you are modifying a `GUILD_FORUM` channel with tags in `available_tags`, for the new ones added, only this field is required. +\*\* At most one of `emoji_id` and `emoji_name` may be set. ### Embed Object From 05e223fe4b6ed0e589c5d0fcd3ab4184cc0cb088 Mon Sep 17 00:00:00 2001 From: MateoDeveloper <79017590+Mateo-tem@users.noreply.github.com> Date: Tue, 20 Sep 2022 20:28:52 -0500 Subject: [PATCH 4/6] modify wording of note Co-authored-by: Shay DeWael --- docs/resources/Channel.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/resources/Channel.md b/docs/resources/Channel.md index 409726a8c0..31a354c41d 100644 --- a/docs/resources/Channel.md +++ b/docs/resources/Channel.md @@ -570,7 +570,7 @@ An object that represents a tag that is able to be applied to a thread in a `GUI | emoji_id | snowflake | the id of a guild's custom emoji \*\* | | emoji_name | ?string | the unicode character of the emoji \*\* | -\* If you are modifying a `GUILD_FORUM` channel with tags in `available_tags`, for the new ones added, only this field is required. +\* When updating a `GUILD_FORUM` channel, tag objects in `available_tags` only require the `name` field. \*\* At most one of `emoji_id` and `emoji_name` may be set. From 912a91f05b10dc04296ffc5dc0146eb0d4636133 Mon Sep 17 00:00:00 2001 From: MateoDeveloper <79017590+Mateo-tem@users.noreply.github.com> Date: Wed, 21 Sep 2022 18:48:35 -0500 Subject: [PATCH 5/6] move note above the table Co-authored-by: Shay DeWael --- docs/resources/Channel.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/docs/resources/Channel.md b/docs/resources/Channel.md index 31a354c41d..092942b92b 100644 --- a/docs/resources/Channel.md +++ b/docs/resources/Channel.md @@ -562,17 +562,18 @@ An object that represents a tag that is able to be applied to a thread in a `GUI ###### Forum Tag Structure +> info +> When updating a `GUILD_FORUM` channel, tag objects in `available_tags` only require the `name` field. + | Field | Type | Description | | ---------- | --------- | -------------------------------------------------------------------------------------------------------------- | | id | snowflake | the id of the tag | -| name \* | string | the name of the tag (0-20 characters) | +| name | string | the name of the tag (0-20 characters) | | moderated | boolean | whether this tag can only be added to or removed from threads by a member with the `MANAGE_THREADS` permission | -| emoji_id | snowflake | the id of a guild's custom emoji \*\* | -| emoji_name | ?string | the unicode character of the emoji \*\* | - -\* When updating a `GUILD_FORUM` channel, tag objects in `available_tags` only require the `name` field. +| emoji_id | snowflake | the id of a guild's custom emoji \* | +| emoji_name | ?string | the unicode character of the emoji \* | -\*\* At most one of `emoji_id` and `emoji_name` may be set. +\* At most one of `emoji_id` and `emoji_name` may be set. ### Embed Object From 991d9a25c5c557c3c89115c6d755a259c44e7bdf Mon Sep 17 00:00:00 2001 From: Mateo Date: Wed, 21 Sep 2022 19:00:57 -0500 Subject: [PATCH 6/6] fix table --- docs/resources/Channel.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/resources/Channel.md b/docs/resources/Channel.md index 092942b92b..ab2479fa22 100644 --- a/docs/resources/Channel.md +++ b/docs/resources/Channel.md @@ -568,10 +568,10 @@ An object that represents a tag that is able to be applied to a thread in a `GUI | Field | Type | Description | | ---------- | --------- | -------------------------------------------------------------------------------------------------------------- | | id | snowflake | the id of the tag | -| name | string | the name of the tag (0-20 characters) | +| name | string | the name of the tag (0-20 characters) | | moderated | boolean | whether this tag can only be added to or removed from threads by a member with the `MANAGE_THREADS` permission | -| emoji_id | snowflake | the id of a guild's custom emoji \* | -| emoji_name | ?string | the unicode character of the emoji \* | +| emoji_id | snowflake | the id of a guild's custom emoji \* | +| emoji_name | ?string | the unicode character of the emoji \* | \* At most one of `emoji_id` and `emoji_name` may be set.