fix(APIMessageSnapshot): mark guild_id as deprecated (#1084)

discordjs · Sep 5, 2024 · 3f3fe21 · 3f3fe21
1 parent 011d439
commit 3f3fe21
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 0 deletions.
diff --git a/deno/payloads/v10/channel.ts b/deno/payloads/v10/channel.ts
@@ -1914,6 +1914,13 @@ export interface APIMessageSnapshot {
 	message: APIMessageSnapshotFields;
 	/**
 	 * Id of the origin message's guild
+	 *
+	 * @deprecated This field doesn't accurately reflect the Discord API as it doesn't exist nor is documented and will
+	 * be removed in the next major version.
+	 *
+	 * It was added in {@link https://github.com/discord/discord-api-docs/pull/6833/commits/d18f72d06d62e6b1d51ca2c1ef308ddc29ff3348 | d18f72d}
+	 * but was later removed before the PR ({@link https://github.com/discord/discord-api-docs/pull/6833 | discord-api-docs#6833}) was merged.
+	 * See {@link https://github.com/discordjs/discord-api-types/pull/1084 | discord-api-types#1084} for more information.
 	 */
 	guild_id?: Snowflake;
 }

diff --git a/deno/payloads/v9/channel.ts b/deno/payloads/v9/channel.ts
@@ -1881,6 +1881,13 @@ export interface APIMessageSnapshot {
 	message: APIMessageSnapshotFields;
 	/**
 	 * Id of the origin message's guild
+	 *
+	 * @deprecated This field doesn't accurately reflect the Discord API as it doesn't exist nor is documented and will
+	 * be removed in the next major version.
+	 *
+	 * It was added in {@link https://github.com/discord/discord-api-docs/pull/6833/commits/d18f72d06d62e6b1d51ca2c1ef308ddc29ff3348 | d18f72d}
+	 * but was later removed before the PR ({@link https://github.com/discord/discord-api-docs/pull/6833 | discord-api-docs#6833}) was merged.
+	 * See {@link https://github.com/discordjs/discord-api-types/pull/1084 | discord-api-types#1084} for more information.
 	 */
 	guild_id?: Snowflake;
 }

diff --git a/payloads/v10/channel.ts b/payloads/v10/channel.ts
@@ -1914,6 +1914,13 @@ export interface APIMessageSnapshot {
 	message: APIMessageSnapshotFields;
 	/**
 	 * Id of the origin message's guild
+	 *
+	 * @deprecated This field doesn't accurately reflect the Discord API as it doesn't exist nor is documented and will
+	 * be removed in the next major version.
+	 *
+	 * It was added in {@link https://github.com/discord/discord-api-docs/pull/6833/commits/d18f72d06d62e6b1d51ca2c1ef308ddc29ff3348 | d18f72d}
+	 * but was later removed before the PR ({@link https://github.com/discord/discord-api-docs/pull/6833 | discord-api-docs#6833}) was merged.
+	 * See {@link https://github.com/discordjs/discord-api-types/pull/1084 | discord-api-types#1084} for more information.
 	 */
 	guild_id?: Snowflake;
 }

diff --git a/payloads/v9/channel.ts b/payloads/v9/channel.ts
@@ -1881,6 +1881,13 @@ export interface APIMessageSnapshot {
 	message: APIMessageSnapshotFields;
 	/**
 	 * Id of the origin message's guild
+	 *
+	 * @deprecated This field doesn't accurately reflect the Discord API as it doesn't exist nor is documented and will
+	 * be removed in the next major version.
+	 *
+	 * It was added in {@link https://github.com/discord/discord-api-docs/pull/6833/commits/d18f72d06d62e6b1d51ca2c1ef308ddc29ff3348 | d18f72d}
+	 * but was later removed before the PR ({@link https://github.com/discord/discord-api-docs/pull/6833 | discord-api-docs#6833}) was merged.
+	 * See {@link https://github.com/discordjs/discord-api-types/pull/1084 | discord-api-types#1084} for more information.
 	 */
 	guild_id?: Snowflake;
 }