`Role`'s `colors` property is nullable

[MahdiBM]

Description

https://discord.com/developers/docs/topics/permissions#role-object-role-flags

Describes Role's colors property as non-nullable, but I just bumped into a decoding issue because it was null.

Steps to Reproduce

Can provide more info if needed, but only I can run the integration tests of my library since it requires my test-bot's token.
This is the CI that failed, not sure if you can see the logs or not:
https://github.com/DiscordBM/DiscordBM/actions/runs/21912720746/job/63271062763

In a bit of rush, but if you need more info I can try to extract the JSON and all.

Expected Behavior

documentation correction.

Current Behavior

documentation is incorrectly saying colors is non-nullable.

Screenshots/Videos

No response

Client and System Information

API v10 via https://github.com/DiscordBM/DiscordBM

[afgiel]

can you supply more details? it is not clear from your logs.
eg

• which endpoint?
• under which conditions?

[Polsy]

Appears to be GET /guilds/xxx/templates, the relevant output is on line 64 of the log. I see the same on my own test server, all the template roles have "colors":null. My template was created in April 2020 which I presume was before the colors field was invented, though that's probably not relevant since MahdiBM's one says it's from today.

[{"code":"JuZJyS4wwcyv","name":"Test", [...] ,"serialized_source_guild":{"name":"Polsyzone", [...] ,"roles":[{"id":0,"name":"@everyone","permissions":104193601,"permissions_new":"2248329584303681","color":0,"colors":null,"hoist":false,"mentionable":false,"icon":null,"unicode_emoji":null}, [...]

[afgiel]

https://github.com/discord/discord-api-spec/blob/c3cdc50c3e958e0c2448209c1c2cabf79fa1ca95/specs/openapi.json#L26137-L26146

GuildTemplateRoleResponse.colors is nullable

[MahdiBM]

Exactly as @Polsy mentioned. it's from serialized_source_guild.roles array in a guild template. The docs (not the openapi spec) don't mention that.

[MahdiBM]

The documentation says serialized_source_guild is "partial guild". Partial guilds's roles elements are always a normal role object, not a partial role object, so this whole thing feels weird if you're not directly using the openapi files + an openapi generator.
Nicest thing would be for Discord to repair the colors there IMO. Not sure what other objects are also affected by possibly having nullable colors.

[MahdiBM]

So for clarity, I'm trying to update the APIs of my library after like 1.5 years (almost done with it) so yeah I've forgotten some stuff ...
One of them is this comment, from 2 years ago:

So ... at least I only need to change this Role type's properties, not the actual main Role's. Therefore this issue is not as bad I thought for the library and the users. Still suboptimal that guild templates are so inconsistent.