Skip to content

Commit ff1b4f3

Browse files
DA-344DA-344
committed
apply suggestions and fix tables
1 parent dc32e77 commit ff1b4f3

File tree

2 files changed

+42
-40
lines changed

2 files changed

+42
-40
lines changed

‎docs/resources/guild.mdx‎

Lines changed: 22 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1231,16 +1231,18 @@ This endpoint supports the `X-Audit-Log-Reason` header.
12311231

12321232
###### JSON Params
12331233

1234-
| Field | Type | Description | Default |
1235-
|---------------|-----------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------|
1236-
| name | string | name of the role, max 100 characters | "new role" |
1237-
| permissions | string | bitwise value of the enabled/disabled permissions | @everyone permissions in guild |
1238-
| color | integer | RGB color value | 0 |
1239-
| colors | [role colors](/docs/topics/permissions#role-colors-object) object | the role's colors | [default role colors object](/docs/topics/permissions#default-role-colors-object) |
1240-
| hoist | boolean | whether the role should be displayed separately in the sidebar | false |
1241-
| icon | ?[image data](/docs/reference#image-data) | the role's icon image (if the guild has the `ROLE_ICONS` feature) | null |
1242-
| unicode_emoji | ?string | the role's unicode emoji as a [standard emoji](/docs/reference#message-formatting) (if the guild has the `ROLE_ICONS` feature) | null |
1243-
| mentionable | boolean | whether the role should be mentionable | false |
1234+
| Field | Type | Description | Default |
1235+
|---------------|-------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------|
1236+
| name | string | name of the role, max 100 characters | "new role" |
1237+
| permissions | string | bitwise value of the enabled/disabled permissions | @everyone permissions in guild |
1238+
| color* | integer | RGB color value | 0 |
1239+
| colors | [role colors](/docs/topics/permissions#role-object-role-colors-object) object | the role's colors | [default role colors object](/docs/topics/permissions#role-object-default-role-colors-object) |
1240+
| hoist | boolean | whether the role should be displayed separately in the sidebar | false |
1241+
| icon | ?[image data](/docs/reference#image-data) | the role's icon image (if the guild has the `ROLE_ICONS` feature) | null |
1242+
| unicode_emoji | ?string | the role's unicode emoji as a [standard emoji](/docs/reference#message-formatting) (if the guild has the `ROLE_ICONS` feature) | null |
1243+
| mentionable | boolean | whether the role should be mentionable | false |
1244+
1245+
\* `color` will still be returned by the API, but using the `colors` field is recommended when doing requests.
12441246

12451247
## Modify Guild Role Positions
12461248
<Route method="PATCH">/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/roles</Route>
@@ -1275,16 +1277,16 @@ This endpoint supports the `X-Audit-Log-Reason` header.
12751277

12761278
###### JSON Params
12771279

1278-
| Field | Type | Description |
1279-
|----------------|----------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------|
1280-
| name | string | name of the role, max 100 characters |
1281-
| permissions | string | bitwise value of the enabled/disabled permissions |
1282-
| color* | integer | RGB color value |
1283-
| colors | [role colors](/docs/topics/permissions#role-colors-object) object | the role's colors |
1284-
| hoist | boolean | whether the role should be displayed separately in the sidebar |
1285-
| icon | [image data](/docs/reference#image-data) | the role's icon image (if the guild has the `ROLE_ICONS` feature) |
1286-
| unicode_emoji | string | the role's unicode emoji as a [standard emoji](/docs/reference#message-formatting) (if the guild has the `ROLE_ICONS` feature) |
1287-
| mentionable | boolean | whether the role should be mentionable |
1280+
| Field | Type | Description |
1281+
|---------------|-------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------|
1282+
| name | string | name of the role, max 100 characters |
1283+
| permissions | string | bitwise value of the enabled/disabled permissions |
1284+
| color* | integer | RGB color value |
1285+
| colors | [role colors](/docs/topics/permissions#role-object-role-colors-object) object | the role's colors |
1286+
| hoist | boolean | whether the role should be displayed separately in the sidebar |
1287+
| icon | [image data](/docs/reference#image-data) | the role's icon image (if the guild has the `ROLE_ICONS` feature) |
1288+
| unicode_emoji | string | the role's unicode emoji as a [standard emoji](/docs/reference#message-formatting) (if the guild has the `ROLE_ICONS` feature) |
1289+
| mentionable | boolean | whether the role should be mentionable |
12881290

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

‎docs/topics/permissions.md‎

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -203,21 +203,21 @@ Roles represent a set of permissions attached to a group of users. Roles have na
203203

204204
###### Role Structure
205205

206-
| Field | Type | Description |
207-
|-----------------|------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------|
208-
| id | snowflake | role id |
209-
| name | string | role name |
210-
| color* | integer | integer representation of hexadecimal color code |
211-
| colors | [role colors](/docs/topics/permissions#role-colors-object) object | the role's colors |
212-
| hoist | boolean | if this role is pinned in the user listing |
213-
| icon? | ?string | role [icon hash](/docs/reference#image-formatting) |
214-
| unicode_emoji? | ?string | role unicode emoji |
215-
| position | integer | position of this role (roles with the same position are sorted by id) |
216-
| permissions | string | permission bit set |
217-
| managed | boolean | whether this role is managed by an integration |
218-
| mentionable | boolean | whether this role is mentionable |
219-
| tags? | [role tags](/docs/topics/permissions#role-object-role-tags-structure) object | the tags this role has |
220-
| flags | integer | [role flags](/docs/topics/permissions#role-object-role-flags) combined as a [bitfield](https://en.wikipedia.org/wiki/Bit_field) |
206+
| Field | Type | Description |
207+
|----------------|-------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------|
208+
| id | snowflake | role id |
209+
| name | string | role name |
210+
| color* | integer | integer representation of hexadecimal color code |
211+
| colors | [role colors](/docs/topics/permissions#role-object-role-colors-object) object | the role's colors |
212+
| hoist | boolean | if this role is pinned in the user listing |
213+
| icon? | ?string | role [icon hash](/docs/reference#image-formatting) |
214+
| unicode_emoji? | ?string | role unicode emoji |
215+
| position | integer | position of this role (roles with the same position are sorted by id) |
216+
| permissions | string | permission bit set |
217+
| managed | boolean | whether this role is managed by an integration |
218+
| mentionable | boolean | whether this role is mentionable |
219+
| tags? | [role tags](/docs/topics/permissions#role-object-role-tags-structure) object | the tags this role has |
220+
| flags | integer | [role flags](/docs/topics/permissions#role-object-role-flags) combined as a [bitfield](https://en.wikipedia.org/wiki/Bit_field) |
221221

222222
Roles without colors (`color == 0`) do not count towards the final computed color in the user list.
223223

@@ -240,11 +240,11 @@ Tags with type `null` represent booleans. They will be present and set to `null`
240240

241241
This object will always be filled with `primary_color` being the role's `color`. Other fields can only be set to a non-null value if the guild has the `ENHANCED_ROLE_COLORS` [guild feature](/docs/resources/guild#guild-object-guild-features).
242242

243-
| Field | Type | Description |
244-
|------------------|----------|--------------------------------------------------------------------------------------------------------|
245-
| primary_color | integer | the primary color for the role |
246-
| secondary_color | ?integer | the secondary color for the role, this will make the role a gradient between the other provided colors |
247-
| tertiary_color | ?integer | the tertiary color for the role, this will turn the gradient into a holographic style |
243+
| Field | Type | Description |
244+
|-----------------|----------|--------------------------------------------------------------------------------------------------------|
245+
| primary_color | integer | the primary color for the role |
246+
| secondary_color | ?integer | the secondary color for the role, this will make the role a gradient between the other provided colors |
247+
| tertiary_color | ?integer | the tertiary color for the role, this will turn the gradient into a holographic style |
248248

249249
:::info
250250
When sending `tertiary_color` the API enforces the role color to be a holographic style with values of:

0 commit comments

Comments
 (0)