Skip to content

Missing change from Role#color deprecation #7664

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jul 8, 2025
Merged

Missing change from Role#color deprecation #7664

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/topics/permissions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -219,7 +219,7 @@ Roles represent a set of permissions attached to a group of users. Roles have na
| tags? | [role tags](/docs/topics/permissions#role-object-role-tags-structure) object | the tags this role has |
| flags | integer | [role flags](/docs/topics/permissions#role-object-role-flags) combined as a [bitfield](https://en.wikipedia.org/wiki/Bit_field) |

Roles without colors (`color == 0`) do not count towards the final computed color in the user list.
Roles without colors (`colors.primary_color == 0`) do not count towards the final computed color in the user list.
Copy link
Contributor

@markmandel markmandel Jul 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤔 should it be both? colour isn't going away (even though it's deprecated), so shouldn't we document this for both values?

Copy link
Contributor

@Jiralite Jiralite Jul 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No. If I were a new developer, I want to see the current state of the API, not the past and mentions of deprecated behaviour.

Copy link
Contributor

@markmandel markmandel Jul 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The flip side of which is - if I'm a developer still using the deprecated API, I still want to know what's going on. I may not migrate to the new API for a while.

We might want two sentence though - it should still be clear that color is deprecated.

Maybe something like:

Roles without colors (`colors.primary_color == 0`) do not count towards the final computed color in the user list. If you are using the deprecated `color` property, it also acts in the same way.

Or something like that.

Copy link
Contributor

@Zoddo Zoddo Jul 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree we want to know that a field is deprecated (at least until a new API version removes it).

However, the table above already conveys this information clearly, and IMO, footnotes should be kept light and use only the new field.

Copy link
Contributor

@markmandel markmandel Jul 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So apparently that is the general guide for these docs 👍🏻 I stand corrected.

In which case, let's take this live! 🚀


\* `color` will still be returned by the API, but using the `colors` field is recommended when doing requests.

Expand Down