Skip to content

Commit

Permalink
Link boolean query string types to reference section
Browse files Browse the repository at this point in the history
  • Loading branch information
@advaith1
advaith1 committed May 7, 2024
1 parent df7d365 commit c092cb1
Show file tree
Hide file tree
Showing 9 changed files with 79 additions and 79 deletions.
32 changes: 16 additions & 16 deletions docs/game_sdk/Store.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -379,18 +379,18 @@ Note that parameters with a `?` after the name denote optional fields. Parameter

Gets entitlements for a given user. You can use this on your game backend to check entitlements of an arbitrary user, or perhaps in an administrative panel for your support team.

###### Query Parameters

| name | type | description |
|----------------|-----------------------------------|--------------------------------------------------------------------------------------------------------------------------------|
| user_id? | snowflake | the user id to look up entitlements for |
| sku_ids? | comma-delimited set of snowflakes | (optional) the list SKU ids to check entitlements for |
| with_payments? | bool | returns [limited payment data](#DOCS_GAME_SDK_STORE/httpspecific-data-models-limited-payment-data-object) for each entitlement |
| before? | snowflake | retrieve entitlements before this time |
| after? | snowflake | retrieve entitlements after this time |
| limit? | int | number of entitlements to return, 1-100, default 100 |
| guild_id? | snowflake | the guild id to look up entitlements for |
| exclude_ended? | bool | whether or not ended entitlements should be omitted |
###### Query String Params

| name | type | description |
|----------------|--------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------|
| user_id? | snowflake | the user id to look up entitlements for |
| sku_ids? | comma-delimited set of snowflakes | (optional) the list SKU ids to check entitlements for |
| with_payments? | [boolean](#DOCS_REFERENCE/boolean-query-strings) | returns [limited payment data](#DOCS_GAME_SDK_STORE/httpspecific-data-models-limited-payment-data-object) for each entitlement |
| before? | snowflake | retrieve entitlements before this time |
| after? | snowflake | retrieve entitlements after this time |
| limit? | int | number of entitlements to return, 1-100, default 100 |
| guild_id? | snowflake | the guild id to look up entitlements for |
| exclude_ended? | [boolean](#DOCS_REFERENCE/boolean-query-strings) | whether or not ended entitlements should be omitted |

###### Example

Expand Down Expand Up @@ -425,11 +425,11 @@ curl https://discord.com/api/v6/applications/461618159171141643/entitlements?use

Fetch an entitlement by its ID. This may be useful in confirming that a user has a given entitlement that another call or the SDK says they do.

###### Query Parameters
###### Query String Params

| name | type | description |
|---------------|------|--------------------------------------------------------------------------------------------------------------------------------|
| with_payment? | bool | returns [limited payment data](#DOCS_GAME_SDK_STORE/httpspecific-data-models-limited-payment-data-object) for each entitlement |
| name | type | description |
|---------------|--------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------|
| with_payment? | [boolean](#DOCS_REFERENCE/boolean-query-strings) | returns [limited payment data](#DOCS_GAME_SDK_STORE/httpspecific-data-models-limited-payment-data-object) for each entitlement |

###### Example

Expand Down
12 changes: 6 additions & 6 deletions docs/interactions/Application_Commands.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1077,9 +1077,9 @@ Fetch all of the global commands for your application. Returns an array of [appl

###### Query String Params

| Field | Type | Description |
|---------------------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| with_localizations? | boolean | Whether to include full localization dictionaries (`name_localizations` and `description_localizations`) in the returned objects, instead of the `name_localized` and `description_localized` fields. Default `false`. |
| Field | Type | Description |
|---------------------|--------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| with_localizations? | [boolean](#DOCS_REFERENCE/boolean-query-strings) | Whether to include full localization dictionaries (`name_localizations` and `description_localizations`) in the returned objects, instead of the `name_localized` and `description_localized` fields. Default `false`. |

## Create Global Application Command % POST /applications/{application.id#DOCS_RESOURCES_APPLICATION/application-object}/commands

Expand Down Expand Up @@ -1152,9 +1152,9 @@ Fetch all of the guild commands for your application for a specific guild. Retur

###### Query String Params

| Field | Type | Description |
|---------------------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| with_localizations? | boolean | Whether to include full localization dictionaries (`name_localizations` and `description_localizations`) in the returned objects, instead of the `name_localized` and `description_localized` fields. Default `false`. |
| Field | Type | Description |
|---------------------|--------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| with_localizations? | [boolean](#DOCS_REFERENCE/boolean-query-strings) | Whether to include full localization dictionaries (`name_localizations` and `description_localizations`) in the returned objects, instead of the `name_localized` and `description_localized` fields. Default `false`. |

## Create Guild Application Command % POST /applications/{application.id#DOCS_RESOURCES_APPLICATION/application-object}/guilds/{guild.id#DOCS_RESOURCES_GUILD/guild-object}/commands

Expand Down
22 changes: 11 additions & 11 deletions docs/monetization/Entitlements.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,17 +48,17 @@ Entitlements in Discord represent that a user or guild has access to a premium o

Returns all entitlements for a given app, active and expired.

###### Query Params

| param | type | description |
|----------------|-----------------------------------|------------------------------------------------------|
| user_id? | snowflake | User ID to look up entitlements for |
| sku_ids? | comma-delimited set of snowflakes | Optional list of SKU IDs to check entitlements for |
| before? | snowflake | Retrieve entitlements before this entitlement ID |
| after? | snowflake | Retrieve entitlements after this entitlement ID |
| limit? | integer | Number of entitlements to return, 1-100, default 100 |
| guild_id? | snowflake | Guild ID to look up entitlements for |
| exclude_ended? | boolean | Whether or not ended entitlements should be omitted |
###### Query String Params

| param | type | description |
|----------------|--------------------------------------------------|------------------------------------------------------|
| user_id? | snowflake | User ID to look up entitlements for |
| sku_ids? | comma-delimited set of snowflakes | Optional list of SKU IDs to check entitlements for |
| before? | snowflake | Retrieve entitlements before this entitlement ID |
| after? | snowflake | Retrieve entitlements after this entitlement ID |
| limit? | integer | Number of entitlements to return, 1-100, default 100 |
| guild_id? | snowflake | Guild ID to look up entitlements for |
| exclude_ended? | [boolean](#DOCS_REFERENCE/boolean-query-strings) | Whether or not ended entitlements should be omitted |

```json
[
Expand Down
16 changes: 8 additions & 8 deletions docs/resources/Channel.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1408,9 +1408,9 @@ When `with_member` is set to `true`, the thread member object will include a `me

###### Query String Params

| Field | Type | Description |
|--------------|---------|-------------------------------------------------------------------------------------------------------------|
| with_member? | boolean | Whether to include a [guild member](#DOCS_RESOURCES_GUILD/guild-member-object) object for the thread member |
| Field | Type | Description |
|--------------|--------------------------------------------------|-------------------------------------------------------------------------------------------------------------|
| with_member? | [boolean](#DOCS_REFERENCE/boolean-query-strings) | Whether to include a [guild member](#DOCS_RESOURCES_GUILD/guild-member-object) object for the thread member |

## List Thread Members % GET /channels/{channel.id#DOCS_RESOURCES_CHANNEL/channel-object}/thread-members

Expand All @@ -1426,11 +1426,11 @@ When `with_member` is set to `true`, the results will be paginated and each thre
###### Query String Params

| Field | Type | Description |
|--------------|-----------|--------------------------------------------------------------------------------------------------------------|
| with_member? | boolean | Whether to include a [guild member](#DOCS_RESOURCES_GUILD/guild-member-object) object for each thread member |
| after? | snowflake | Get thread members after this user ID |
| limit? | integer | Max number of thread members to return (1-100). Defaults to 100. |
| Field | Type | Description |
|--------------|--------------------------------------------------|--------------------------------------------------------------------------------------------------------------|
| with_member? | [boolean](#DOCS_REFERENCE/boolean-query-strings) | Whether to include a [guild member](#DOCS_RESOURCES_GUILD/guild-member-object) object for each thread member |
| after? | snowflake | Get thread members after this user ID |
| limit? | integer | Max number of thread members to return (1-100). Defaults to 100. |

## List Public Archived Threads % GET /channels/{channel.id#DOCS_RESOURCES_CHANNEL/channel-object}/threads/archived/public

Expand Down
6 changes: 3 additions & 3 deletions docs/resources/Guild.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -720,9 +720,9 @@ Returns the [guild](#DOCS_RESOURCES_GUILD/guild-object) object for the given id.

###### Query String Params

| Field | Type | Description | Required | Default |
|--------------|---------|-------------------------------------------------------------------------------|----------|---------|
| with_counts? | boolean | when `true`, will return approximate member and presence counts for the guild | false | false |
| Field | Type | Description | Required | Default |
|--------------|--------------------------------------------------|-------------------------------------------------------------------------------|----------|---------|
| with_counts? | [boolean](#DOCS_REFERENCE/boolean-query-strings) | when `true`, will return approximate member and presence counts for the guild | false | false |

###### Example Response

Expand Down
24 changes: 12 additions & 12 deletions docs/resources/Guild_Scheduled_Event.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -108,9 +108,9 @@ Returns a list of [guild scheduled event](#DOCS_RESOURCES_GUILD_SCHEDULED_EVENT/

###### Query String Params

| Field | Type | Description |
|------------------|---------|--------------------------------------------------|
| with_user_count? | boolean | include number of users subscribed to each event |
| Field | Type | Description |
|------------------|--------------------------------------------------|--------------------------------------------------|
| with_user_count? | [boolean](#DOCS_REFERENCE/boolean-query-strings) | include number of users subscribed to each event |

## Create Guild Scheduled Event % POST /guilds/{guild.id#DOCS_RESOURCES_GUILD/guild-object}/scheduled-events

Expand Down Expand Up @@ -146,9 +146,9 @@ Get a guild scheduled event. Returns a [guild scheduled event](#DOCS_RESOURCES_G

###### Query String Params

| Field | Type | Description |
|------------------|---------|--------------------------------------------------|
| with_user_count? | boolean | include number of users subscribed to this event |
| Field | Type | Description |
|------------------|--------------------------------------------------|--------------------------------------------------|
| with_user_count? | [boolean](#DOCS_REFERENCE/boolean-query-strings) | include number of users subscribed to this event |

## Modify Guild Scheduled Event % PATCH /guilds/{guild.id#DOCS_RESOURCES_GUILD/guild-object}/scheduled-events/{guild_scheduled_event.id#DOCS_RESOURCES_GUILD_SCHEDULED_EVENT/guild-scheduled-event-object}

Expand Down Expand Up @@ -194,12 +194,12 @@ Get a list of guild scheduled event users subscribed to a guild scheduled event.

###### Query String Params

| Field | Type | Description | Default |
|--------------|-----------|-----------------------------------------------|---------|
| limit? | number | number of users to return (up to maximum 100) | 100 |
| with_member? | boolean | include guild member data if it exists | false |
| before? * | snowflake | consider only users before given user id | null |
| after? * | snowflake | consider only users after given user id | null |
| Field | Type | Description | Default |
|--------------|--------------------------------------------------|-----------------------------------------------|---------|
| limit? | number | number of users to return (up to maximum 100) | 100 |
| with_member? | [boolean](#DOCS_REFERENCE/boolean-query-strings) | include guild member data if it exists | false |
| before? * | snowflake | consider only users before given user id | null |
| after? * | snowflake | consider only users after given user id | null |

\* Provide a user id to `before` and `after` for pagination. Users will always be returned in ascending order by `user_id`. If both `before` and `after` are provided, only `before` is respected. Fetching users in-between `before` and `after` is not supported.

Expand Down
Loading

0 comments on commit c092cb1

Please sign in to comment.