Skip to content

Commit 4c148be

Browse files
authored
Updated endpoint paths after link normalization (#7479)
1 parent 315d886 commit 4c148be

11 files changed

+50
-56
lines changed

docs/change-log/2021-11-23-guild-scheduled-events.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ date: "2021-11-23"
77

88
#### Nov 18, 2021
99

10-
* Breaking change for return type for `GET /guilds/{guild.id}/scheduled-events/{guild-scheduled-event.id}/users`
11-
* Add `with_user_count` query param for `GET /guilds/{guild.id}/scheduled-events/{guild-scheduled-event.id}`
12-
* Return additional `creator` field by default in response for `GET /guilds/{guild.id}/scheduled-events/{guild-scheduled-event.id}`
10+
* Breaking change for return type for `GET /guilds/{guild.id}/scheduled-events/{guild_scheduled_event.id}/users`
11+
* Add `with_user_count` query param for `GET /guilds/{guild.id}/scheduled-events/{guild_scheduled_event.id}`
12+
* Return additional `creator` field by default in response for `GET /guilds/{guild.id}/scheduled-events/{guild_scheduled_event.id}`
1313
* More details and clarification for the guild scheduled events feature.
14-
* Document support for `before` and `after` query params for `GET /guilds/{guild.id}/scheduled-events/{guild-scheduled-event.id}/users`
14+
* Document support for `before` and `after` query params for `GET /guilds/{guild.id}/scheduled-events/{guild_scheduled_event.id}/users`
1515

1616
#### Nov 15, 2021
1717

docs/events/gateway.mdx

-1
Original file line numberDiff line numberDiff line change
@@ -715,7 +715,6 @@ Returns an object with a valid WSS URL which the app can use when [Connecting](/
715715
```
716716

717717
## Get Gateway Bot
718-
719718
<Route method="GET">/gateway/bot</Route>
720719

721720
:::warn

docs/interactions/application-commands.mdx

+3-6
Original file line numberDiff line numberDiff line change
@@ -301,9 +301,9 @@ Application command permissions allow your app to enable or disable commands for
301301
Command permissions can only be updated using a [Bearer token](/docs/topics/oauth2#client-credentials-grant). Authenticating with a bot token will result in an error.
302302
:::
303303

304-
A command's current permissions can be retrieved using the [`GET /applications/\{application.id}/guilds/\{guild.id}/commands/\{command.id}/permissions`](/docs/interactions/application-commands#get-application-command-permissions) endpoint. The response will include an array called `permissions` with associated IDs and permission types.
304+
A command's current permissions can be retrieved using the [`GET /applications/{application.id}/guilds/{guild.id}/commands/{command.id}/permissions`](/docs/interactions/application-commands#get-application-command-permissions) endpoint. The response will include an array called `permissions` with associated IDs and permission types.
305305

306-
Command permissions can be updated with the [`PUT /applications/\{application.id}/guilds/\{guild.id}/commands/\{command.id}/permissions`](/docs/interactions/application-commands#edit-application-command-permissions) endpoint. To call the endpoint, apps must use a Bearer token that's authorized with the [`applications.commands.permissions.update`](/docs/topics/oauth2#shared-resources-oauth2-scopes) scope from a user with sufficient permissions. For their permissions to be considered sufficient, all of the following must be true for **the authenticating user** (not your app or bot user):
306+
Command permissions can be updated with the [`PUT /applications/{application.id}/guilds/{guild.id}/commands/{command.id}/permissions`](/docs/interactions/application-commands#edit-application-command-permissions) endpoint. To call the endpoint, apps must use a Bearer token that's authorized with the [`applications.commands.permissions.update`](/docs/topics/oauth2#shared-resources-oauth2-scopes) scope from a user with sufficient permissions. For their permissions to be considered sufficient, all of the following must be true for **the authenticating user** (not your app or bot user):
307307
- Has [permission to Manage Guild and Manage Roles](/docs/topics/permissions) in the guild where the command is being edited
308308
- Has the ability to run the command being edited
309309
- Has permission to manage the resources that will be affected (roles, users, and/or channels depending on the [permission types](/docs/interactions/application-commands#application-command-permissions-object-application-command-permission-type))
@@ -1307,14 +1307,12 @@ Edit a guild command. Updates for guild commands will be available immediately.
13071307
| nsfw? | boolean | Indicates whether the command is [age-restricted](/docs/interactions/application-commands#agerestricted-commands) |
13081308

13091309
## Delete Guild Application Command
1310-
13111310
<Route method="DELETE">/applications/[\{application.id\}](/docs/resources/application#application-object)/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/commands/[\{command.id\}](/docs/interactions/application-commands#application-command-object)</Route>
13121311

13131312
Delete a guild command. Returns `204 No Content` on success.
13141313

13151314
## Bulk Overwrite Guild Application Commands
1316-
1317-
<Route method="PUT">/applications/\{application.id/docs/resources/application#application-object\}/guilds/\{guild.id/docs/resources/guild#guild-object\}/commands</Route>
1315+
<Route method="PUT">/applications/[\{application.id\}](/docs/resources/application#application-object)/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/commands</Route>
13181316

13191317
Takes a list of application commands, overwriting the existing command list for this application for the targeted guild. Returns `200` and a list of [application command](/docs/interactions/application-commands#application-command-object) objects.
13201318

@@ -1341,7 +1339,6 @@ This will overwrite **all** types of application commands: slash commands, user
13411339
| nsfw? | boolean | Indicates whether the command is [age-restricted](/docs/interactions/application-commands#agerestricted-commands) |
13421340

13431341
## Get Guild Application Command Permissions
1344-
13451342
<Route method="GET">/applications/[\{application.id\}](/docs/resources/application#application-object)/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/commands/permissions</Route>
13461343

13471344
Fetches permissions for all commands for your application in a guild. Returns an array of [guild application command permissions](/docs/interactions/application-commands#application-command-permissions-object-guild-application-command-permissions-structure) objects.

docs/interactions/receiving-and-responding.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -389,7 +389,7 @@ The endpoints below are not bound to the application's [Global Rate Limit](/docs
389389
:::
390390

391391
## Create Interaction Response
392-
<Route method="POST">/interactions/[\{interaction.id}](/docs/interactions/receiving-and-responding#interaction-object)/[\{interaction.token\}](/docs/interactions/receiving-and-responding#interaction-object)/callback</Route>
392+
<Route method="POST">/interactions/[\{interaction.id\}](/docs/interactions/receiving-and-responding#interaction-object)/[\{interaction.token\}](/docs/interactions/receiving-and-responding#interaction-object)/callback</Route>
393393

394394
Create a response to an Interaction. Body is an [interaction response](/docs/interactions/receiving-and-responding#interaction-response-object). Returns `204` unless `with_response` is set to `true` which returns `200` with the body as [interaction callback response](/docs/interactions/receiving-and-responding#interaction-callback-interaction-callback-response-object).
395395

docs/resources/application-role-connection-metadata.mdx

-2
Original file line numberDiff line numberDiff line change
@@ -39,13 +39,11 @@ Each metadata type offers a comparison operation that allows guilds to configure
3939
:::
4040

4141
## Get Application Role Connection Metadata Records
42-
4342
<Route method="GET">/applications/[\{application.id\}](/docs/resources/application#application-object)/role-connections/metadata</Route>
4443

4544
Returns a list of [application role connection metadata](/docs/resources/application-role-connection-metadata#application-role-connection-metadata-object) objects for the given application.
4645

4746
## Update Application Role Connection Metadata Records
48-
4947
<Route method="PUT">/applications/[\{application.id\}](/docs/resources/application#application-object)/role-connections/metadata</Route>
5048

5149
Updates and returns a list of [application role connection metadata](/docs/resources/application-role-connection-metadata#application-role-connection-metadata-object) objects for the given application.

docs/resources/application.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -263,7 +263,7 @@ All parameters to this endpoint are optional
263263
\*\* To update an Interactions endpoint URL via the API, the URL must be valid according to the [Receiving an Interaction](/docs/interactions/receiving-and-responding#receiving-an-interaction) documentation.
264264

265265
## Get Application Activity Instance
266-
<Route>/applications/[\{application.id\}](/docs/resources/application#application-object)/activity-instances/[\{instance_id\}](/docs/resources/application#get-application-activity-instance-activity-instance-object)</Route>
266+
<Route method="GET">/applications/[\{application.id\}](/docs/resources/application#application-object)/activity-instances/[\{instance_id\}](/docs/resources/application#get-application-activity-instance-activity-instance-object)</Route>
267267

268268
Returns a serialized activity instance, if it exists. Useful for [preventing unwanted activity sessions](/docs/activities/development-guides/multiplayer-experience#preventing-unwanted-activity-sessions).
269269

docs/resources/entitlement.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ After creating a test entitlement, you'll need to reload your Discord client. Af
152152
```
153153

154154
## Delete Test Entitlement
155-
<Route method="DELETE">/applications/[\{application.id\}](/docs/resources/application#application-object)/entitlements/[\{entitlement.id\}](/docs/resources/entitlement#entitlement-object)</Route>
155+
<Route method="DELETE">/applications/[\{application.id\}](/docs/resources/application#application-object)/entitlements/[\{entitlement.id\}](/docs/resources/entitlement#entitlement-object)</Route>
156156

157157
Deletes a currently-active test entitlement. Discord will act as though that user or guild _no longer has_ entitlement to your premium offering.
158158

docs/resources/guild-scheduled-event.mdx

+4-4
Original file line numberDiff line numberDiff line change
@@ -305,7 +305,7 @@ This endpoint supports the `X-Audit-Log-Reason` header.
305305
\*\* Required for events with `'entity_type': EXTERNAL`
306306

307307
## Get Guild Scheduled Event
308-
<Route method="GET">/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/scheduled-events/[\{guild-scheduled-event.id\}](/docs/resources/guild-scheduled-event#guild-scheduled-event-object)</Route>
308+
<Route method="GET">/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/scheduled-events/[\{guild_scheduled_event.id\}](/docs/resources/guild-scheduled-event#guild-scheduled-event-object)</Route>
309309

310310
Get a guild scheduled event. Returns a [guild scheduled event](/docs/resources/guild-scheduled-event#guild-scheduled-event-object) object on success.
311311

@@ -316,7 +316,7 @@ Get a guild scheduled event. Returns a [guild scheduled event](/docs/resources/g
316316
| with_user_count? | [boolean](/docs/reference#boolean-query-strings) | include number of users subscribed to this event |
317317

318318
## Modify Guild Scheduled Event
319-
<Route method="PATCH">/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/scheduled-events/[\{guild-scheduled-event.id\}](/docs/resources/guild-scheduled-event#guild-scheduled-event-object)</Route>
319+
<Route method="PATCH">/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/scheduled-events/[\{guild_scheduled_event.id\}](/docs/resources/guild-scheduled-event#guild-scheduled-event-object)</Route>
320320

321321
Modify a guild scheduled event. Returns the modified [guild scheduled event](/docs/resources/guild-scheduled-event#guild-scheduled-event-object) object on success. Fires a [Guild Scheduled Event Update](/docs/events/gateway-events#guild-scheduled-event-update) Gateway event.
322322

@@ -360,12 +360,12 @@ All parameters to this endpoint are optional
360360
- `scheduled_end_time` must be provided
361361

362362
## Delete Guild Scheduled Event
363-
<Route method="DELETE">/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/scheduled-events/[\{guild-scheduled-event.id\}](/docs/resources/guild-scheduled-event#guild-scheduled-event-object)</Route>
363+
<Route method="DELETE">/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/scheduled-events/[\{guild_scheduled_event.id\}](/docs/resources/guild-scheduled-event#guild-scheduled-event-object)</Route>
364364

365365
Delete a guild scheduled event. Returns a `204` on success. Fires a [Guild Scheduled Event Delete](/docs/events/gateway-events#guild-scheduled-event-delete) Gateway event.
366366

367367
## Get Guild Scheduled Event Users
368-
<Route method="GET">/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/scheduled-events/[\{guild-scheduled-event.id\}](/docs/resources/guild-scheduled-event#guild-scheduled-event-object)/users</Route>
368+
<Route method="GET">/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/scheduled-events/[\{guild_scheduled_event.id\}](/docs/resources/guild-scheduled-event#guild-scheduled-event-object)/users</Route>
369369

370370
Get a list of guild scheduled event users subscribed to a guild scheduled event. Returns a list of [guild scheduled event user](/docs/resources/guild-scheduled-event#guild-scheduled-event-user-object) objects on success. Guild member data, if it exists, is included if the `with_member` query parameter is set.
371371

docs/resources/message.mdx

+5-5
Original file line numberDiff line numberDiff line change
@@ -835,25 +835,25 @@ Crosspost a message in an Announcement Channel to following channels. This endpo
835835
Returns a [message](/docs/resources/message#message-object) object. Fires a [Message Update](/docs/events/gateway-events#message-update) Gateway event.
836836

837837
## Create Reaction
838-
<Route method="PUT">/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages/[\{message.id\}](/docs/resources/message#message-object)/reactions/[\{emoji/docs/resources/emoji#emoji-object}/@me</Route>
838+
<Route method="PUT">/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages/[\{message.id\}](/docs/resources/message#message-object)/reactions/[\{emoji.id\}](/docs/resources/emoji#emoji-object)/@me</Route>
839839

840840
Create a reaction for the message. This endpoint requires the `READ_MESSAGE_HISTORY` permission to be present on the current user. Additionally, if nobody else has reacted to the message using this emoji, this endpoint requires the `ADD_REACTIONS` permission to be present on the current user. Returns a 204 empty response on success. Fires a [Message Reaction Add](/docs/events/gateway-events#message-reaction-add) Gateway event.
841841
The `emoji` must be [URL Encoded](https://en.wikipedia.org/wiki/Percent-encoding) or the request will fail with `10014: Unknown Emoji`. To use custom emoji, you must encode it in the format `name:id` with the emoji name and emoji id.
842842

843843
## Delete Own Reaction
844-
<Route method="DELETE">/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages/[\{message.id\}](/docs/resources/message#message-object)/reactions/[\{emoji/docs/resources/emoji#emoji-object}/@me</Route>
844+
<Route method="DELETE">/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages/[\{message.id\}](/docs/resources/message#message-object)/reactions/[\{emoji.id\}](/docs/resources/emoji#emoji-object)/@me</Route>
845845

846846
Delete a reaction the current user has made for the message. Returns a 204 empty response on success. Fires a [Message Reaction Remove](/docs/events/gateway-events#message-reaction-remove) Gateway event.
847847
The `emoji` must be [URL Encoded](https://en.wikipedia.org/wiki/Percent-encoding) or the request will fail with `10014: Unknown Emoji`. To use custom emoji, you must encode it in the format `name:id` with the emoji name and emoji id.
848848

849849
## Delete User Reaction
850-
<Route method="DELETE">/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages/[\{message.id\}](/docs/resources/message#message-object)/reactions/[\{emoji/docs/resources/emoji#emoji-object}/[\{user.id\}](/docs/resources/user#user-object)</Route>
850+
<Route method="DELETE">/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages/[\{message.id\}](/docs/resources/message#message-object)/reactions/[\{emoji.id\}](/docs/resources/emoji#emoji-object)/[\{user.id\}](/docs/resources/user#user-object)</Route>
851851

852852
Deletes another user's reaction. This endpoint requires the `MANAGE_MESSAGES` permission to be present on the current user. Returns a 204 empty response on success. Fires a [Message Reaction Remove](/docs/events/gateway-events#message-reaction-remove) Gateway event.
853853
The `emoji` must be [URL Encoded](https://en.wikipedia.org/wiki/Percent-encoding) or the request will fail with `10014: Unknown Emoji`. To use custom emoji, you must encode it in the format `name:id` with the emoji name and emoji id.
854854

855855
## Get Reactions
856-
<Route method="GET">/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages/[\{message.id\}](/docs/resources/message#message-object)/reactions/[\{emoji/docs/resources/emoji#emoji-object}</Route>
856+
<Route method="GET">/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages/[\{message.id\}](/docs/resources/message#message-object)/reactions/[\{emoji.id\}](/docs/resources/emoji#emoji-object)</Route>
857857

858858
Get a list of users that reacted with this emoji. Returns an array of [user](/docs/resources/user#user-object) objects on success.
859859
The `emoji` must be [URL Encoded](https://en.wikipedia.org/wiki/Percent-encoding) or the request will fail with `10014: Unknown Emoji`. To use custom emoji, you must encode it in the format `name:id` with the emoji name and emoji id.
@@ -879,7 +879,7 @@ The `emoji` must be [URL Encoded](https://en.wikipedia.org/wiki/Percent-encoding
879879
Deletes all reactions on a message. This endpoint requires the `MANAGE_MESSAGES` permission to be present on the current user. Fires a [Message Reaction Remove All](/docs/events/gateway-events#message-reaction-remove-all) Gateway event.
880880

881881
## Delete All Reactions for Emoji
882-
<Route method="DELETE">/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages/[\{message.id\}](/docs/resources/message#message-object)/reactions/[\{emoji/docs/resources/emoji#emoji-object}</Route>
882+
<Route method="DELETE">/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages/[\{message.id\}](/docs/resources/message#message-object)/reactions/[\{emoji.id\}](/docs/resources/emoji#emoji-object)</Route>
883883

884884
Deletes all the reactions for a given emoji on a message. This endpoint requires the `MANAGE_MESSAGES` permission to be present on the current user. Fires a [Message Reaction Remove Emoji](/docs/events/gateway-events#message-reaction-remove-emoji) Gateway event.
885885
The `emoji` must be [URL Encoded](https://en.wikipedia.org/wiki/Percent-encoding) or the request will fail with `10014: Unknown Emoji`. To use custom emoji, you must encode it in the format `name:id` with the emoji name and emoji id.

docs/resources/sticker.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ Represents a pack of standard stickers.
101101
```
102102

103103
## Get Sticker
104-
<Route method="GET">/stickers/[\{sticker.id\}](/docs/resources/sticker#sticker-object)</Route>
104+
<Route method="GET">/stickers/[\{sticker.id\}](/docs/resources/sticker#sticker-object)</Route>
105105

106106
Returns a [sticker](/docs/resources/sticker#sticker-object) object for the given sticker ID.
107107

0 commit comments

Comments
 (0)