From ad286203138d1f149d1a88fb19f966e981d5c506 Mon Sep 17 00:00:00 2001 From: Vyr Cossont Date: Mon, 20 Mar 2023 12:05:24 -0700 Subject: [PATCH] Update Role docs to remove attrs that aren't serialized (#1188) Also added more realistic example permissions for the Owner role --- content/en/entities/Role.md | 28 ++-------------------------- 1 file changed, 2 insertions(+), 26 deletions(-) diff --git a/content/en/entities/Role.md b/content/en/entities/Role.md index 381dde8d..717093d5 100644 --- a/content/en/entities/Role.md +++ b/content/en/entities/Role.md @@ -19,11 +19,8 @@ aliases: [ "id": 3, "name": "Owner", "color": "#ff3838", - "position": 1000, - "permissions": 1, - "highlighted": true, - "created_at": "2022-09-08T22:48:07.983Z", - "updated_at": "2022-09-08T22:48:07.983Z" + "permissions": 1048575, + "highlighted": true }, ``` @@ -50,13 +47,6 @@ aliases: [ **Version history:**\ 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} **Description:** A bitmask that represents the sum of all permissions granted to the role.\ @@ -71,20 +61,6 @@ aliases: [ **Version history:**\ 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 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.