Skip to content

Conversation

@donaldchen
Copy link

@donaldchen donaldchen commented Jan 6, 2025

Because the JSON fields for the channel update payload are all optional, either all of the fields or none of the fields in the table should have the ? which indicates optionality. I chose to remove the ? for all of them, so developers can refer to this highlighted part of the doc as the source of truth.

Screenshot 2025-01-06 at 3 24 10 PM

@donaldchen donaldchen marked this pull request as ready for review January 6, 2025 23:25
@donaldchen donaldchen requested a review from a team as a code owner January 6, 2025 23:25
@donaldchen donaldchen requested review from shaydewael and removed request for a team January 6, 2025 23:25
@Misha-133
Copy link
Contributor

This PR also removes ? indicating nullable fields, not optional. It is a different thing and should not be changed. https://discord.com/developers/docs/reference#nullable-and-optional-resource-fields

@donaldchen
Copy link
Author

This PR also removes ? indicating nullable fields, not optional. It is a different thing and should not be changed. https://discord.com/developers/docs/reference#nullable-and-optional-resource-fields

Good catch! I'll update that

@colinloretz colinloretz self-requested a review January 10, 2025 21:17
@colinloretz colinloretz merged commit 262c864 into discord:main Jan 10, 2025
4 checks passed
mazylol pushed a commit to mazylol/discord-api-docs that referenced this pull request Jul 3, 2025
* remove redundant question marks for channel update params
* Moved optional param note to info callout

---------

Co-authored-by: Colin Loretz <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants