From 9f594da61451cd19ae4e0ada79a12f58f4fed699 Mon Sep 17 00:00:00 2001 From: Fleny Date: Mon, 28 Jul 2025 08:25:22 +0200 Subject: [PATCH] api-docs: Update the description for identity_enabled to be clearer (#4266) * Update the description for identity_enabled to be clearer * Update packages/bot/src/transformers/types.ts Co-authored-by: Link --------- Co-authored-by: Link --- packages/bot/src/transformers/types.ts | 8 +++++++- packages/types/src/discord/user.ts | 8 +++++++- 2 files changed, 14 insertions(+), 2 deletions(-) diff --git a/packages/bot/src/transformers/types.ts b/packages/bot/src/transformers/types.ts index e85deaff2..49fb1e5df 100644 --- a/packages/bot/src/transformers/types.ts +++ b/packages/bot/src/transformers/types.ts @@ -1814,7 +1814,13 @@ export interface Nameplate { export interface UserPrimaryGuild { /** The id of the primary guild */ identityGuildId?: bigint - /** Whether the user is displaying the primary guild's server tag. This can be undefined if the system clears the identity, e.g. because the server no longer supports tags. */ + /** + * Whether the user is displaying the primary guild's server tag. + * + * @remarks + * This can be `undefined` if the system clears the identity, e.g. because the server no longer supports tags. + * This will be `false` if the user manually removes their tag. + */ identityEnabled?: boolean /** The text of the user's server tag. Limited to 4 characters */ tag?: string diff --git a/packages/types/src/discord/user.ts b/packages/types/src/discord/user.ts index 9818dae53..f77c4d54f 100644 --- a/packages/types/src/discord/user.ts +++ b/packages/types/src/discord/user.ts @@ -75,7 +75,13 @@ export enum PremiumTypes { export interface DiscordUserPrimaryGuild { /** The id of the primary guild */ identity_guild_id: string | null - /** Whether the user is displaying the primary guild's server tag. This can be `null` if the system clears the identity, e.g. because the server no longer supports tags. */ + /** + * Whether the user is displaying the primary guild's server tag. + * + * @remarks + * This can be `null` if the system clears the identity, e.g. because the server no longer supports tags. + * This will be `false` if the user manually removes their tag. + */ identity_enabled: boolean | null /** The text of the user's server tag. Limited to 4 characters */ tag: string | null