zelo72
/
documentation
mirror of https://github.com/mastodon/documentation
1
0
Fork 0
Code Issues 6 Releases Wiki Activity

Update Role docs to remove attrs that aren't serialized (#1188) 

Also added more realistic example permissions for the Owner role
This commit is contained in:
Vyr Cossont 2023-03-20 12:05:24 -07:00 committed by GitHub
parent 9fd09540cb
commit ad28620313
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
content/en/entities/Role.md
View File

@ -19,11 +19,8 @@ aliases: [
"id": 3, "id": 3,
"name": "Owner", "name": "Owner",
"color": "#ff3838", "color": "#ff3838",
"position": 1000, "permissions": 1048575,
"permissions": 1, "highlighted": true
"highlighted": true,
"created_at": "2022-09-08T22:48:07.983Z",
"updated_at": "2022-09-08T22:48:07.983Z"
}, },
``` ```
@ -50,13 +47,6 @@ aliases: [
**Version history:**\ **Version history:**\
4.0.0 - added 4.0.0 - added
### `position` {#position}
**Description:** An index for the role's position. The higher the position, the more priority the role has over other roles.\
**Type:** Integer\
**Version history:**\
4.0.0 - added
### `permissions` {#permissions} ### `permissions` {#permissions}
**Description:** A bitmask that represents the sum of all permissions granted to the role.\ **Description:** A bitmask that represents the sum of all permissions granted to the role.\
@ -71,20 +61,6 @@ aliases: [
**Version history:**\ **Version history:**\
4.0.0 - added 4.0.0 - added
### `created_at` {#created_at}
**Description:** The date that the role was created.\
**Type:** String (ISO 8601 Datetime)\
**Version history:**\
4.0.0 - added
### `updated_at` {#created_at}
**Description:** The date that the role was updated.\
**Type:** String (ISO 8601 Datetime)\
**Version history:**\
4.0.0 - added
## Permission flags ## Permission flags
To determine the permissions available to a certain role, convert the `permissions` attribute to binary and compare from the least significant bit upwards. For convenience (and to prevent the terms from growing too long), permissions will be presented below using hexadecimal values. To determine the permissions available to a certain role, convert the `permissions` attribute to binary and compare from the least significant bit upwards. For convenience (and to prevent the terms from growing too long), permissions will be presented below using hexadecimal values.