Skip to content

Commit

Permalink
Document with_counts param for GET /users/@me/guilds (#5628)
Browse files Browse the repository at this point in the history 
* Document with_counts param for GET /users/@me/guilds

* Update docs/resources/Guild.md

---------

Co-authored-by: shay <swdewael@gmail.com>
  • Loading branch information
@JohnyTheCarrot @shaydewael
JohnyTheCarrot and shaydewael committed Jul 13, 2023
1 parent 1f30d7c commit ee1de00
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 8 deletions.
4 changes: 2 additions & 2 deletions docs/resources/Guild.md
View file
Expand Up @@ -47,8 +47,8 @@ Guilds in Discord represent an isolated collection of users and channels, and ar
| public_updates_channel_id | ?snowflake | the id of the channel where admins and moderators of Community guilds receive notices from Discord |
| max_video_channel_users? | integer | the maximum amount of users in a video channel |
| max_stage_video_channel_users? | integer | the maximum amount of users in a stage video channel |
| approximate_member_count? | integer | approximate number of members in this guild, returned from the `GET /guilds/<id>` endpoint when `with_counts` is `true` |
| approximate_presence_count? | integer | approximate number of non-offline members in this guild, returned from the `GET /guilds/<id>` endpoint when `with_counts` is `true` |
| approximate_member_count? | integer | approximate number of members in this guild, returned from the `GET /guilds/<id>` and `/users/@me/guilds` endpoints when `with_counts` is `true` |
| approximate_presence_count? | integer | approximate number of non-offline members in this guild, returned from the `GET /guilds/<id>` and `/users/@me/guilds` endpoints when `with_counts` is `true` |
| welcome_screen? | [welcome screen](#DOCS_RESOURCES_GUILD/welcome-screen-object) object | the welcome screen of a Community guild, shown to new members, returned in an [Invite](#DOCS_RESOURCES_INVITE/invite-object)'s guild object |
| nsfw_level | integer | [guild NSFW level](#DOCS_RESOURCES_GUILD/guild-object-guild-nsfw-level) |
| stickers? | array of [sticker](#DOCS_RESOURCES_STICKER/sticker-object) objects | custom guild stickers |
Expand Down
15 changes: 9 additions & 6 deletions docs/resources/User.md
View file
Expand Up @@ -192,7 +192,9 @@ Returns a list of partial [guild](#DOCS_RESOURCES_GUILD/guild-object) objects th
"icon": "8342729096ea3675442027381ff50dfe",
"owner": true,
"permissions": "36953089",
"features": ["COMMUNITY", "NEWS"]
"features": ["COMMUNITY", "NEWS"],
"approximate_member_count": 3268,
"approximate_presence_count": 784
}
```

Expand All @@ -201,11 +203,12 @@ Returns a list of partial [guild](#DOCS_RESOURCES_GUILD/guild-object) objects th
###### Query String Params

| Field | Type | Description | Required | Default |
| ------ | --------- | -------------------------------------- | -------- | ------- |
| before | snowflake | get guilds before this guild ID | false | absent |
| after | snowflake | get guilds after this guild ID | false | absent |
| limit | integer | max number of guilds to return (1-200) | false | 200 |
| Field | Type | Description | Required | Default |
| ----------- | --------- | ---------------------------------------------------------- | -------- | ------- |
| before | snowflake | get guilds before this guild ID | false | absent |
| after | snowflake | get guilds after this guild ID | false | absent |
| limit | integer | max number of guilds to return (1-200) | false | 200 |
| with_counts | boolean | include approximate member and presence counts in response | false | false |

## Get Current User Guild Member % GET /users/@me/guilds/{guild.id#DOCS_RESOURCES_GUILD/guild-object}/member

Expand Down

0 comments on commit ee1de00

Please sign in to comment.