mastodon / documentation

Mastodon documentation
https://docs.joinmastodon.org
GNU Free Documentation License v1.3
1.7k stars 975 forks source link

The `roles` attribute is missing from the `Account` entity #1483

Open anosidium opened 1 month ago

anosidium commented 1 month ago

The documentation does not list roles (plural) attribute in the Account entity but it does list role (singular) attribute. I found out by inspecting the Instance entity of various instances using this endpoint: GET /api/v2/instance.

It returns an array of Role entities but permissions and highlighted attribute are absent. So the documentation for Role entity should mark these attributes as nullable.

ClearlyClaire commented 1 month ago

At this time, the CredentialAccount entity does have a (singular) role attribute, so that is correct.

The Account entity is indeed lacking documentation for the roles attribute added in Mastodon v4.1.0. The type of the CredentialAccount role attribute is slightly different from the Account roles, which indeed omits permissions and highlighted.

anosidium commented 1 month ago

So what you are saying is that CredentialAccount entity role attribute return a Role entity but roles attribute return an array of a different entity type? If so then that entity needs to be added to the API Entities list.

ClearlyClaire commented 1 month ago

Yes, that's it, they are of a different type, and the roles in Account are unfortunately currently undocumented.