-
Notifications
You must be signed in to change notification settings - Fork 1.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
avatar_decoration
field in User
object is undocumented
#5690
Comments
the existence of undocumented fields is not a bug, they're just related to unreleased features. the rule of thumb is if it's not documented, ignore it |
How is this completed? The fields are still undocumented and the PR to actually resolve this is still open. |
Likely since it was reported as a bug but it is not. |
Funny definition of 'completed'. |
Like AlmostSuspense said, this is not a bug. If you'd prefer I not "complete" it, I could delete it instead :) |
If you want to point out where the solution is 'just ignore it', fine, I will admit that I missed it (although adding fields to a versioned API seems questionable). Otherwise, the fact that not all fields are documented should be documented for serialisation libraries that will throw an exception by default if unknown fields are attempted to be serialised (i.e KotlinX Serialization).
Aside from being an incredibly immature response, this is also unhelpful in the event someone else runs into the same issue and wants to see the solution :) |
Per discord/discord-api-docs#5690 the solution appears to be to just ignore them
Not all fields returned by the API are actually documented, and per discord/discord-api-docs#5690 the solution seems to be to ignore them
Description
A
User
object returned by the Discord API returns an undocumented field namedavatar_decoration
.Steps to Reproduce
Invoke an endpoint that returns a
User
objectExpected Behavior
The Discord API returns only fields documented at https://discord.com/developers/docs/resources/user#user-object-user-structure.
Current Behavior
The Discord API returns the fields documented at https://discord.com/developers/docs/resources/user#user-object-user-structure and an additional
avatar_decoration
field.Screenshots/Videos
No response
Client and System Information
Own library
The text was updated successfully, but these errors were encountered: