discord-api-docs icon indicating copy to clipboard operation
discord-api-docs copied to clipboard

Inconsistent presence of server mute and deafen fields in member payloads

Open almostSouji opened this issue 5 months ago • 0 comments

Description

  • https://discord.com/developers/docs/resources/guild#guild-member-object-guild-member-structure documents deaf and mute as non-optional.
  • https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object does not document the member as partial

Knowledge about this influences how we deal with this on a library level (whether we can assume presence and expose the field directly or need to implement these with or recommend an additional GET call to retrieve the current state)

Steps to Reproduce

Receive INTERACTION_CREATE payload (ws) Receive GUILD_MEMBER_UPDATE payload (ws)

Observe missing deaf and mute fields

Expected Behavior

Preferably the deaf and mute fields should be present in the cases described herein If this is not feasible, they should at least be documented as nullable and missing in these cases (though their presence is clearly preferable)

Current Behavior

Inconsistent presence of the deaf and mute fields:

Present on:

  • Event: MESSAGE_CREATE (inner)
  • Event: MESSAGE_REACTION_ADD (inner)
  • Event: THREAD_MEMBERS_UPDATE (inner)
  • Event: GUILD_MEMBER_ADD
  • Event: GUILD_MEMBERS_CHUNK
  • Response: GET /guilds/:id/members/:id
  • Response: GET /guilds/:id/members
  • Response: GET /guilds/:id/members/search
  • Response: PATCH /guilds/:id/members/:id

Not present on:

  • Event: GUILD_MEMBER_UPDATE
  • Event: INTERACTION_CREATE (inner)

Screenshots/Videos

No response

Client and System Information

n/a

almostSouji avatar Sep 05 '24 15:09 almostSouji