GitBucket
{
"openapi": "3.1.0",
"info": {
"title": "Spacebar Server",
"description": "Spacebar is a free open source selfhostable discord compatible chat, voice and video platform",
"license": {
"name": "AGPLV3",
"url": "https://www.gnu.org/licenses/agpl-3.0.en.html"
},
"version": "1.0.0"
},
"externalDocs": {
"description": "Spacebar Docs",
"url": "https://docs.spacebar.chat"
},
"servers": [
{
"url": "https://old.server.spacebar.chat/api/",
"description": "Official Spacebar Instance"
}
],
"components": {
"securitySchemes": {
"bearer": {
"type": "http",
"scheme": "bearer",
"description": "Bearer/Bot prefixes are not required.",
"bearerFormat": "JWT",
"in": "header"
}
},
"schemas": {
"AckBulkSchema": {
"type": "object",
"properties": {
"read_states": {
"type": "array",
"items": {
"type": "object",
"properties": {
"channel_id": {
"type": "string"
},
"message_id": {
"type": "string"
},
"read_state_type": {
"type": "integer"
}
},
"additionalProperties": false,
"required": [
"channel_id",
"message_id",
"read_state_type"
]
}
}
},
"required": [
"read_states"
]
},
"ConnectedAccountCommonOAuthTokenResponse": {
"type": "object",
"properties": {
"access_token": {
"type": "string"
},
"token_type": {
"type": "string"
},
"scope": {
"type": "string"
},
"refresh_token": {
"type": "string"
},
"expires_in": {
"type": "integer"
}
},
"required": [
"access_token",
"scope",
"token_type"
]
},
"ApplicationAuthorizeSchema": {
"type": "object",
"properties": {
"authorize": {
"type": "boolean"
},
"guild_id": {
"type": "string"
},
"permissions": {
"type": "string"
},
"captcha_key": {
"type": "string"
},
"code": {
"type": "string"
}
},
"required": [
"authorize",
"guild_id",
"permissions"
]
},
"ApplicationCreateSchema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"team_id": {
"type": [
"string",
"integer"
]
}
},
"required": [
"name"
]
},
"ApplicationModifySchema": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"icon": {
"type": "string"
},
"interactions_endpoint_url": {
"type": "string"
},
"max_participants": {
"type": "integer",
"nullable": true
},
"name": {
"type": "string"
},
"privacy_policy_url": {
"type": "string"
},
"role_connections_verification_url": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"terms_of_service_url": {
"type": "string"
},
"bot_public": {
"type": "boolean"
},
"bot_require_code_grant": {
"type": "boolean"
},
"flags": {
"type": "integer"
}
}
},
"BackupCodesChallengeSchema": {
"type": "object",
"properties": {
"password": {
"type": "string"
}
},
"required": [
"password"
]
},
"BanCreateSchema": {
"type": "object",
"properties": {
"delete_message_seconds": {
"type": "string"
},
"delete_message_days": {
"type": "string"
},
"reason": {
"type": "string"
}
}
},
"BanModeratorSchema": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"user_id": {
"type": "string"
},
"guild_id": {
"type": "string"
},
"executor_id": {
"type": "string"
},
"reason": {
"type": "string"
}
},
"required": [
"executor_id",
"guild_id",
"id",
"user_id"
]
},
"BanRegistrySchema": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"user_id": {
"type": "string"
},
"guild_id": {
"type": "string"
},
"executor_id": {
"type": "string"
},
"ip": {
"type": "string"
},
"reason": {
"type": "string"
}
},
"required": [
"executor_id",
"guild_id",
"id",
"user_id"
]
},
"BotModifySchema": {
"type": "object",
"properties": {
"avatar": {
"type": "string"
},
"username": {
"type": "string"
}
}
},
"ChannelPermissionOverwriteType": {
"enum": [
0,
1,
2
],
"type": "number"
},
"ConnectedAccountTokenData": {
"type": "object",
"properties": {
"access_token": {
"type": "string"
},
"token_type": {
"type": "string"
},
"scope": {
"type": "string"
},
"refresh_token": {
"type": "string"
},
"expires_in": {
"type": "integer"
},
"expires_at": {
"type": "integer"
},
"fetched_at": {
"type": "integer"
}
},
"required": [
"access_token",
"fetched_at"
]
},
"ChannelModifySchema": {
"type": "object",
"properties": {
"name": {
"maxLength": 100,
"type": "string"
},
"type": {
"enum": [
0,
1,
10,
11,
12,
13,
14,
15,
2,
255,
3,
33,
34,
35,
4,
5,
6,
64,
7,
8,
9
],
"type": "number"
},
"topic": {
"type": "string"
},
"icon": {
"type": "string",
"nullable": true
},
"bitrate": {
"type": "integer"
},
"user_limit": {
"type": "integer"
},
"rate_limit_per_user": {
"type": "integer"
},
"position": {
"type": "integer"
},
"permission_overwrites": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ChannelPermissionOverwriteType"
},
"allow": {
"type": "string"
},
"deny": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"allow",
"deny",
"id",
"type"
]
}
},
"parent_id": {
"type": "string"
},
"id": {
"type": "string"
},
"nsfw": {
"type": "boolean"
},
"rtc_region": {
"type": "string"
},
"default_auto_archive_duration": {
"type": "integer"
},
"default_reaction_emoji": {
"type": "string",
"nullable": true
},
"flags": {
"type": "integer"
},
"default_thread_rate_limit_per_user": {
"type": "integer"
},
"video_quality_mode": {
"type": "integer"
}
}
},
"ActivitySchema": {
"type": "object",
"properties": {
"afk": {
"type": "boolean"
},
"status": {
"$ref": "#/components/schemas/Status"
},
"activities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Activity"
}
},
"since": {
"type": "integer"
}
},
"required": [
"status"
]
},
"Status": {
"enum": [
"dnd",
"idle",
"invisible",
"offline",
"online"
],
"type": "string"
},
"Activity": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ActivityType"
},
"url": {
"type": "string"
},
"created_at": {
"type": "integer"
},
"timestamps": {
"type": "object",
"properties": {
"start": {
"type": "integer"
},
"end": {
"type": "integer"
}
},
"additionalProperties": false,
"required": [
"end",
"start"
]
},
"application_id": {
"type": "string"
},
"details": {
"type": "string"
},
"state": {
"type": "string"
},
"emoji": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"id": {
"type": "string"
},
"animated": {
"type": "boolean"
}
},
"additionalProperties": false,
"required": [
"animated",
"name"
]
},
"party": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"size": {
"type": "array",
"items": {
"type": "integer"
}
}
},
"additionalProperties": false
},
"assets": {
"type": "object",
"properties": {
"large_image": {
"type": "string"
},
"large_text": {
"type": "string"
},
"small_image": {
"type": "string"
},
"small_text": {
"type": "string"
}
},
"additionalProperties": false
},
"secrets": {
"type": "object",
"properties": {
"join": {
"type": "string"
},
"spectate": {
"type": "string"
},
"match": {
"type": "string"
}
},
"additionalProperties": false
},
"instance": {
"type": "boolean"
},
"flags": {
"type": "string"
},
"id": {
"type": "string"
},
"sync_id": {
"type": "string"
},
"metadata": {
"type": "object",
"properties": {
"context_uri": {
"type": "string"
},
"album_id": {
"type": "string"
},
"artist_ids": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false,
"required": [
"album_id",
"artist_ids"
]
},
"session_id": {
"type": "string"
}
},
"required": [
"flags",
"name",
"session_id",
"type"
]
},
"ActivityType": {
"enum": [
0,
1,
2,
4,
5
],
"type": "number"
},
"Embed": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"type": {
"enum": [
"article",
"gifv",
"image",
"link",
"rich",
"video"
],
"type": "string"
},
"description": {
"type": "string"
},
"url": {
"type": "string"
},
"timestamp": {
"type": "string",
"format": "date-time"
},
"color": {
"type": "integer"
},
"footer": {
"type": "object",
"properties": {
"text": {
"type": "string"
},
"icon_url": {
"type": "string"
},
"proxy_icon_url": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"text"
]
},
"image": {
"$ref": "#/components/schemas/EmbedImage"
},
"thumbnail": {
"$ref": "#/components/schemas/EmbedImage"
},
"video": {
"$ref": "#/components/schemas/EmbedImage"
},
"provider": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"url": {
"type": "string"
}
},
"additionalProperties": false
},
"author": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"url": {
"type": "string"
},
"icon_url": {
"type": "string"
},
"proxy_icon_url": {
"type": "string"
}
},
"additionalProperties": false
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"inline": {
"type": "boolean"
}
},
"additionalProperties": false,
"required": [
"name",
"value"
]
}
}
}
},
"EmbedImage": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"proxy_url": {
"type": "string"
},
"height": {
"type": "integer"
},
"width": {
"type": "integer"
}
}
},
"ChannelOverride": {
"type": "object",
"properties": {
"message_notifications": {
"type": "integer"
},
"mute_config": {
"$ref": "#/components/schemas/MuteConfig"
},
"muted": {
"type": "boolean"
},
"channel_id": {
"type": "string",
"nullable": true
}
},
"required": [
"channel_id",
"message_notifications",
"mute_config",
"muted"
]
},
"MuteConfig": {
"type": "object",
"properties": {
"end_time": {
"type": "integer"
},
"selected_time_window": {
"type": "integer"
}
},
"required": [
"end_time",
"selected_time_window"
]
},
"CustomStatus": {
"type": "object",
"properties": {
"emoji_id": {
"type": "string"
},
"emoji_name": {
"type": "string"
},
"expires_at": {
"type": "integer"
},
"text": {
"type": "string"
}
}
},
"FriendSourceFlags": {
"type": "object",
"properties": {
"all": {
"type": "boolean"
}
},
"required": [
"all"
]
},
"GuildFolder": {
"type": "object",
"properties": {
"color": {
"type": "integer"
},
"guild_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"id": {
"type": "integer"
},
"name": {
"type": "string"
}
},
"required": [
"color",
"guild_ids",
"id",
"name"
]
},
"GenerateWebAuthnCredentialsSchema": {
"type": "object",
"properties": {
"password": {
"type": "string"
}
},
"required": [
"password"
]
},
"CreateWebAuthnCredentialSchema": {
"type": "object",
"properties": {
"credential": {
"type": "string"
},
"name": {
"type": "string"
},
"ticket": {
"type": "string"
}
},
"required": [
"credential",
"name",
"ticket"
]
},
"APIErrorResponse": {
"type": "object",
"properties": {
"code": {
"type": "integer"
},
"message": {
"type": "string"
},
"errors": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"_errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"code": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"code",
"message"
]
}
}
},
"additionalProperties": false,
"required": [
"_errors"
]
}
}
},
"required": [
"code",
"errors",
"message"
]
},
"CaptchaRequiredResponse": {
"type": "object",
"properties": {
"captcha_key": {
"type": "string"
},
"captcha_sitekey": {
"type": "string"
},
"captcha_service": {
"type": "string"
}
},
"required": [
"captcha_key",
"captcha_service",
"captcha_sitekey"
]
},
"Guild": {
"type": "object",
"properties": {
"afk_channel_id": {
"type": "string"
},
"afk_channel": {
"$ref": "#/components/schemas/Channel"
},
"afk_timeout": {
"type": "integer"
},
"bans": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Ban"
}
},
"banner": {
"type": "string"
},
"default_message_notifications": {
"type": "integer"
},
"description": {
"type": "string"
},
"discovery_splash": {
"type": "string"
},
"explicit_content_filter": {
"type": "integer"
},
"features": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"primary_category_id": {
"type": "string"
},
"icon": {
"type": "string"
},
"large": {
"type": "boolean",
"default": false
},
"max_members": {
"type": "integer"
},
"max_presences": {
"type": "integer"
},
"max_video_channel_users": {
"type": "integer"
},
"member_count": {
"type": "integer"
},
"presence_count": {
"type": "integer"
},
"members": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Member"
}
},
"roles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Role"
}
},
"channels": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Channel"
}
},
"template_id": {
"type": "string"
},
"template": {
"$ref": "#/components/schemas/Template"
},
"emojis": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Emoji"
}
},
"stickers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Sticker"
}
},
"invites": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Invite"
}
},
"voice_states": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VoiceState"
}
},
"webhooks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Webhook"
}
},
"mfa_level": {
"type": "integer"
},
"name": {
"type": "string"
},
"owner_id": {
"type": "string"
},
"owner": {
"$ref": "#/components/schemas/User"
},
"preferred_locale": {
"type": "string"
},
"premium_subscription_count": {
"type": "integer"
},
"premium_tier": {
"type": "integer"
},
"public_updates_channel_id": {
"type": "string"
},
"public_updates_channel": {
"$ref": "#/components/schemas/Channel"
},
"rules_channel_id": {
"type": "string"
},
"rules_channel": {
"type": "string"
},
"region": {
"type": "string"
},
"splash": {
"type": "string"
},
"system_channel_id": {
"type": "string"
},
"system_channel": {
"$ref": "#/components/schemas/Channel"
},
"system_channel_flags": {
"type": "integer"
},
"unavailable": {
"type": "boolean",
"default": false
},
"verification_level": {
"type": "integer"
},
"welcome_screen": {
"$ref": "#/components/schemas/GuildWelcomeScreen"
},
"widget_channel_id": {
"type": "string"
},
"widget_channel": {
"$ref": "#/components/schemas/Channel"
},
"widget_enabled": {
"type": "boolean",
"default": true
},
"nsfw_level": {
"type": "integer"
},
"nsfw": {
"type": "boolean",
"default": false
},
"parent": {
"type": "string"
},
"permissions": {
"type": "integer"
},
"premium_progress_bar_enabled": {
"type": "boolean",
"default": false
},
"id": {
"type": "string"
}
},
"required": [
"bans",
"channels",
"emojis",
"features",
"id",
"invites",
"members",
"name",
"nsfw",
"premium_progress_bar_enabled",
"public_updates_channel_id",
"roles",
"stickers",
"template",
"unavailable",
"voice_states",
"webhooks",
"welcome_screen",
"widget_enabled"
]
},
"Channel": {
"type": "object",
"properties": {
"created_at": {
"type": "string",
"format": "date-time"
},
"name": {
"type": "string"
},
"icon": {
"type": "string",
"nullable": true
},
"type": {
"$ref": "#/components/schemas/ChannelType"
},
"recipients": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Recipient"
}
},
"last_message_id": {
"type": "string"
},
"guild_id": {
"type": "string"
},
"guild": {
"$ref": "#/components/schemas/Guild"
},
"parent_id": {
"type": "string"
},
"parent": {
"$ref": "#/components/schemas/Channel"
},
"owner_id": {
"type": "string"
},
"owner": {
"$ref": "#/components/schemas/User"
},
"last_pin_timestamp": {
"type": "integer"
},
"default_auto_archive_duration": {
"type": "integer"
},
"position": {
"type": "integer"
},
"permission_overwrites": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChannelPermissionOverwrite"
}
},
"video_quality_mode": {
"type": "integer"
},
"bitrate": {
"type": "integer"
},
"user_limit": {
"type": "integer"
},
"nsfw": {
"type": "boolean",
"default": false
},
"rate_limit_per_user": {
"type": "integer"
},
"topic": {
"type": "string"
},
"invites": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Invite"
}
},
"retention_policy_id": {
"type": "string"
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Message"
}
},
"voice_states": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VoiceState"
}
},
"read_states": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReadState"
}
},
"webhooks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Webhook"
}
},
"flags": {
"type": "integer",
"default": 0
},
"default_thread_rate_limit_per_user": {
"type": "integer",
"default": 0
},
"id": {
"type": "string"
}
},
"required": [
"created_at",
"default_thread_rate_limit_per_user",
"flags",
"guild",
"id",
"nsfw",
"owner",
"parent_id",
"type"
]
},
"ChannelType": {
"enum": [
0,
1,
10,
11,
12,
13,
14,
15,
2,
255,
3,
33,
34,
35,
4,
5,
6,
64,
7,
8,
9
],
"type": "number"
},
"Recipient": {
"type": "object",
"properties": {
"channel_id": {
"type": "string"
},
"channel": {
"$ref": "#/components/schemas/Channel"
},
"user_id": {
"type": "string"
},
"user": {
"$ref": "#/components/schemas/User"
},
"closed": {
"type": "boolean"
},
"id": {
"type": "string"
}
},
"required": [
"channel",
"channel_id",
"closed",
"id",
"user",
"user_id"
]
},
"User": {
"type": "object",
"properties": {
"username": {
"type": "string"
},
"discriminator": {
"type": "string"
},
"avatar": {
"type": "string"
},
"accent_color": {
"type": "integer"
},
"banner": {
"type": "string"
},
"theme_colors": {
"type": "array",
"items": {
"type": "integer"
}
},
"pronouns": {
"type": "string"
},
"phone": {
"type": "string"
},
"desktop": {
"type": "boolean",
"default": false
},
"mobile": {
"type": "boolean",
"default": false
},
"premium": {
"type": "boolean"
},
"premium_type": {
"type": "integer"
},
"bot": {
"type": "boolean",
"default": false
},
"bio": {
"type": "string",
"default": ""
},
"system": {
"type": "boolean",
"default": false
},
"nsfw_allowed": {
"type": "boolean",
"default": true
},
"mfa_enabled": {
"type": "boolean",
"default": false
},
"webauthn_enabled": {
"type": "boolean",
"default": false
},
"totp_secret": {
"type": "string",
"default": ""
},
"totp_last_ticket": {
"type": "string",
"default": ""
},
"created_at": {
"type": "string",
"format": "date-time"
},
"premium_since": {
"type": "string",
"format": "date-time"
},
"verified": {
"type": "boolean"
},
"disabled": {
"type": "boolean",
"default": false
},
"deleted": {
"type": "boolean",
"default": false
},
"email": {
"type": "string"
},
"flags": {
"type": "string",
"default": "0"
},
"public_flags": {
"type": "integer",
"default": 0
},
"purchased_flags": {
"type": "integer",
"default": 0
},
"premium_usage_flags": {
"type": "integer",
"default": 0
},
"rights": {
"type": "string"
},
"sessions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Session"
}
},
"relationships": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Relationship"
}
},
"connected_accounts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConnectedAccount"
}
},
"data": {
"type": "object",
"properties": {
"valid_tokens_since": {
"type": "string",
"format": "date-time"
},
"hash": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"valid_tokens_since"
]
},
"fingerprints": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"settings": {
"$ref": "#/components/schemas/UserSettings"
},
"extended_settings": {
"type": "string",
"default": "{}"
},
"security_keys": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SecurityKey"
}
},
"id": {
"type": "string"
}
},
"required": [
"bio",
"bot",
"connected_accounts",
"created_at",
"data",
"deleted",
"desktop",
"disabled",
"discriminator",
"extended_settings",
"fingerprints",
"flags",
"id",
"mfa_enabled",
"mobile",
"nsfw_allowed",
"premium",
"premium_since",
"premium_type",
"premium_usage_flags",
"public_flags",
"purchased_flags",
"relationships",
"rights",
"security_keys",
"sessions",
"settings",
"system",
"username",
"verified",
"webauthn_enabled"
]
},
"Session": {
"type": "object",
"properties": {
"user_id": {
"type": "string"
},
"user": {
"$ref": "#/components/schemas/User"
},
"session_id": {
"type": "string"
},
"activities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Activity"
}
},
"client_info": {
"type": "object",
"properties": {
"client": {
"type": "string"
},
"os": {
"type": "string"
},
"version": {
"type": "integer"
}
},
"additionalProperties": false,
"required": [
"client",
"os",
"version"
]
},
"status": {
"$ref": "#/components/schemas/Status"
},
"id": {
"type": "string"
}
},
"required": [
"activities",
"client_info",
"id",
"session_id",
"status",
"user",
"user_id"
]
},
"Relationship": {
"type": "object",
"properties": {
"from_id": {
"type": "string"
},
"from": {
"$ref": "#/components/schemas/User"
},
"to_id": {
"type": "string"
},
"to": {
"$ref": "#/components/schemas/User"
},
"nickname": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/RelationshipType"
},
"id": {
"type": "string"
}
},
"required": [
"from",
"from_id",
"id",
"to",
"to_id",
"type"
]
},
"RelationshipType": {
"enum": [
1,
2,
3,
4
],
"type": "number"
},
"ConnectedAccount": {
"type": "object",
"properties": {
"external_id": {
"type": "string"
},
"user_id": {
"type": "string"
},
"user": {
"$ref": "#/components/schemas/User"
},
"friend_sync": {
"type": "boolean",
"default": false
},
"name": {
"type": "string"
},
"revoked": {
"type": "boolean",
"default": false
},
"show_activity": {
"type": "integer",
"default": 0
},
"type": {
"type": "string"
},
"verified": {
"type": "boolean",
"default": true
},
"visibility": {
"type": "integer",
"default": 0
},
"integrations": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"metadata_": {},
"metadata_visibility": {
"type": "integer",
"default": 0
},
"two_way_link": {
"type": "boolean",
"default": false
},
"token_data": {
"anyOf": [
{
"$ref": "#/components/schemas/ConnectedAccountTokenData"
},
{
"type": "null"
}
]
},
"id": {
"type": "string"
}
},
"required": [
"external_id",
"id",
"name",
"type",
"user",
"user_id"
]
},
"UserSettings": {
"type": "object",
"properties": {
"index": {
"type": "string"
},
"afk_timeout": {
"type": "integer",
"default": 3600
},
"allow_accessibility_detection": {
"type": "boolean",
"default": true
},
"animate_emoji": {
"type": "boolean",
"default": true
},
"animate_stickers": {
"type": "integer",
"default": 0
},
"contact_sync_enabled": {
"type": "boolean",
"default": false
},
"convert_emoticons": {
"type": "boolean",
"default": false
},
"custom_status": {
"anyOf": [
{
"$ref": "#/components/schemas/CustomStatus"
},
{
"type": "null"
}
],
"default": null
},
"default_guilds_restricted": {
"type": "boolean",
"default": false
},
"detect_platform_accounts": {
"type": "boolean",
"default": false
},
"developer_mode": {
"type": "boolean",
"default": true
},
"disable_games_tab": {
"type": "boolean",
"default": true
},
"enable_tts_command": {
"type": "boolean",
"default": false
},
"explicit_content_filter": {
"type": "integer",
"default": 0
},
"friend_source_flags": {
"$ref": "#/components/schemas/FriendSourceFlags"
},
"gateway_connected": {
"type": "boolean",
"default": false
},
"gif_auto_play": {
"type": "boolean",
"default": false
},
"guild_folders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GuildFolder"
},
"default": []
},
"guild_positions": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"inline_attachment_media": {
"type": "boolean",
"default": true
},
"inline_embed_media": {
"type": "boolean",
"default": true
},
"locale": {
"type": "string",
"default": "en-US"
},
"message_display_compact": {
"type": "boolean",
"default": false
},
"native_phone_integration_enabled": {
"type": "boolean",
"default": true
},
"render_embeds": {
"type": "boolean",
"default": true
},
"render_reactions": {
"type": "boolean",
"default": true
},
"restricted_guilds": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"show_current_game": {
"type": "boolean",
"default": true
},
"status": {
"enum": [
"dnd",
"idle",
"invisible",
"offline",
"online"
],
"type": "string",
"default": "online"
},
"stream_notifications_enabled": {
"type": "boolean",
"default": false
},
"theme": {
"enum": [
"dark",
"light"
],
"type": "string",
"default": "dark"
},
"timezone_offset": {
"type": "integer",
"default": 0
}
},
"required": [
"afk_timeout",
"allow_accessibility_detection",
"animate_emoji",
"animate_stickers",
"contact_sync_enabled",
"convert_emoticons",
"custom_status",
"default_guilds_restricted",
"detect_platform_accounts",
"developer_mode",
"disable_games_tab",
"enable_tts_command",
"explicit_content_filter",
"friend_source_flags",
"gateway_connected",
"gif_auto_play",
"guild_folders",
"guild_positions",
"index",
"inline_attachment_media",
"inline_embed_media",
"locale",
"message_display_compact",
"native_phone_integration_enabled",
"render_embeds",
"render_reactions",
"restricted_guilds",
"show_current_game",
"status",
"stream_notifications_enabled",
"theme",
"timezone_offset"
]
},
"SecurityKey": {
"type": "object",
"properties": {
"user_id": {
"type": "string"
},
"user": {
"$ref": "#/components/schemas/User"
},
"key_id": {
"type": "string"
},
"public_key": {
"type": "string"
},
"counter": {
"type": "integer"
},
"name": {
"type": "string"
},
"id": {
"type": "string"
}
},
"required": [
"counter",
"id",
"key_id",
"name",
"public_key",
"user",
"user_id"
]
},
"ChannelPermissionOverwrite": {
"type": "object",
"properties": {
"allow": {
"type": "string"
},
"deny": {
"type": "string"
},
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ChannelPermissionOverwriteType"
}
},
"required": [
"allow",
"deny",
"id",
"type"
]
},
"Invite": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"temporary": {
"type": "boolean"
},
"uses": {
"type": "integer"
},
"max_uses": {
"type": "integer"
},
"max_age": {
"type": "integer"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"expires_at": {
"type": "string",
"format": "date-time"
},
"guild_id": {
"type": "string"
},
"guild": {
"$ref": "#/components/schemas/Guild"
},
"channel_id": {
"type": "string"
},
"channel": {
"$ref": "#/components/schemas/Channel"
},
"inviter_id": {
"type": "string"
},
"inviter": {
"$ref": "#/components/schemas/User"
},
"target_user_id": {
"type": "string"
},
"target_user": {
"type": "string"
},
"target_user_type": {
"type": "integer"
},
"vanity_url": {
"type": "boolean"
}
},
"required": [
"channel",
"channel_id",
"code",
"created_at",
"expires_at",
"guild",
"guild_id",
"inviter",
"max_age",
"max_uses",
"target_user_id",
"temporary",
"uses"
]
},
"Message": {
"type": "object",
"properties": {
"channel_id": {
"type": "string"
},
"channel": {
"$ref": "#/components/schemas/Channel"
},
"guild_id": {
"type": "string"
},
"guild": {
"$ref": "#/components/schemas/Guild"
},
"author_id": {
"type": "string"
},
"author": {
"$ref": "#/components/schemas/User"
},
"member_id": {
"type": "string"
},
"member": {
"$ref": "#/components/schemas/Member"
},
"webhook_id": {
"type": "string"
},
"webhook": {
"$ref": "#/components/schemas/Webhook"
},
"application_id": {
"type": "string"
},
"application": {
"$ref": "#/components/schemas/Application"
},
"content": {
"type": "string"
},
"timestamp": {
"type": "string",
"format": "date-time"
},
"edited_timestamp": {
"type": "string",
"format": "date-time"
},
"tts": {
"type": "boolean"
},
"mention_everyone": {
"type": "boolean"
},
"mentions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/User"
}
},
"mention_roles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Role"
}
},
"mention_channels": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Channel"
}
},
"sticker_items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Sticker"
}
},
"attachments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Attachment_1"
}
},
"embeds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Embed"
}
},
"reactions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reaction"
}
},
"nonce": {
"type": "string"
},
"pinned": {
"type": "boolean"
},
"type": {
"$ref": "#/components/schemas/MessageType"
},
"activity": {
"type": "object",
"properties": {
"type": {
"type": "integer"
},
"party_id": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"party_id",
"type"
]
},
"flags": {
"type": "string"
},
"message_reference": {
"type": "object",
"properties": {
"message_id": {
"type": "string"
},
"channel_id": {
"type": "string"
},
"guild_id": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"message_id"
]
},
"referenced_message": {
"$ref": "#/components/schemas/Message"
},
"interaction": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/InteractionType"
},
"name": {
"type": "string"
},
"user_id": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id",
"name",
"type",
"user_id"
]
},
"components": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MessageComponent"
}
},
"id": {
"type": "string"
}
},
"required": [
"channel",
"embeds",
"id",
"mention_channels",
"mention_roles",
"mentions",
"reactions",
"timestamp",
"type"
]
},
"Member": {
"type": "object",
"properties": {
"index": {
"type": "string"
},
"id": {
"type": "string"
},
"user": {
"$ref": "#/components/schemas/User"
},
"guild_id": {
"type": "string"
},
"guild": {
"$ref": "#/components/schemas/Guild"
},
"nick": {
"type": "string"
},
"roles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Role"
}
},
"joined_at": {
"type": "string",
"format": "date-time"
},
"premium_since": {
"type": "integer"
},
"deaf": {
"type": "boolean"
},
"mute": {
"type": "boolean"
},
"pending": {
"type": "boolean"
},
"settings": {
"$ref": "#/components/schemas/UserGuildSettings"
},
"last_message_id": {
"type": "string"
},
"joined_by": {
"type": "string"
},
"avatar": {
"type": "string"
},
"banner": {
"type": "string"
},
"bio": {
"type": "string"
},
"theme_colors": {
"type": "array",
"items": {
"type": "integer"
}
},
"pronouns": {
"type": "string"
},
"communication_disabled_until": {
"type": "string",
"format": "date-time"
}
},
"required": [
"avatar",
"banner",
"bio",
"communication_disabled_until",
"deaf",
"guild",
"guild_id",
"id",
"index",
"joined_at",
"joined_by",
"mute",
"pending",
"roles",
"settings",
"user"
]
},
"Role": {
"type": "object",
"properties": {
"guild_id": {
"type": "string"
},
"guild": {
"$ref": "#/components/schemas/Guild"
},
"color": {
"type": "integer"
},
"hoist": {
"type": "boolean"
},
"managed": {
"type": "boolean"
},
"mentionable": {
"type": "boolean"
},
"name": {
"type": "string"
},
"permissions": {
"type": "string"
},
"position": {
"type": "integer"
},
"icon": {
"type": "string"
},
"unicode_emoji": {
"type": "string"
},
"tags": {
"type": "object",
"properties": {
"bot_id": {
"type": "string"
},
"integration_id": {
"type": "string"
},
"premium_subscriber": {
"type": "boolean"
}
},
"additionalProperties": false
},
"id": {
"type": "string"
}
},
"required": [
"color",
"guild",
"guild_id",
"hoist",
"id",
"managed",
"mentionable",
"name",
"permissions",
"position"
]
},
"UserGuildSettings": {
"type": "object",
"properties": {
"channel_overrides": {
"anyOf": [
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/ChannelOverride"
}
},
{
"type": "null"
}
]
},
"message_notifications": {
"type": "integer"
},
"mobile_push": {
"type": "boolean"
},
"mute_config": {
"anyOf": [
{
"$ref": "#/components/schemas/MuteConfig"
},
{
"type": "null"
}
]
},
"muted": {
"type": "boolean"
},
"suppress_everyone": {
"type": "boolean"
},
"suppress_roles": {
"type": "boolean"
},
"version": {
"type": "integer"
},
"guild_id": {
"type": "string",
"nullable": true
},
"flags": {
"type": "integer"
},
"mute_scheduled_events": {
"type": "boolean"
},
"hide_muted_channels": {
"type": "boolean"
},
"notify_highlights": {
"type": "number",
"enum": [
0
]
}
},
"required": [
"channel_overrides",
"flags",
"guild_id",
"hide_muted_channels",
"message_notifications",
"mobile_push",
"mute_config",
"mute_scheduled_events",
"muted",
"notify_highlights",
"suppress_everyone",
"suppress_roles",
"version"
]
},
"Webhook": {
"type": "object",
"properties": {
"type": {
"$ref": "#/components/schemas/WebhookType"
},
"name": {
"type": "string"
},
"avatar": {
"type": "string"
},
"token": {
"type": "string"
},
"guild_id": {
"type": "string"
},
"guild": {
"$ref": "#/components/schemas/Guild"
},
"channel_id": {
"type": "string"
},
"channel": {
"$ref": "#/components/schemas/Channel"
},
"application_id": {
"type": "string"
},
"application": {
"$ref": "#/components/schemas/Application"
},
"user_id": {
"type": "string"
},
"user": {
"$ref": "#/components/schemas/User"
},
"source_guild_id": {
"type": "string"
},
"source_guild": {
"$ref": "#/components/schemas/Guild"
},
"id": {
"type": "string"
}
},
"required": [
"application",
"application_id",
"channel",
"channel_id",
"guild",
"guild_id",
"id",
"source_guild",
"source_guild_id",
"type",
"user",
"user_id"
]
},
"WebhookType": {
"enum": [
1,
2,
3
],
"type": "number"
},
"Application": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"icon": {
"type": "string"
},
"description": {
"type": "string"
},
"summary": {
"type": "string",
"default": ""
},
"type": {
"type": "object",
"properties": {},
"additionalProperties": true
},
"hook": {
"type": "boolean",
"default": true
},
"bot_public": {
"type": "boolean",
"default": true
},
"bot_require_code_grant": {
"type": "boolean",
"default": false
},
"verify_key": {
"type": "string"
},
"owner": {
"$ref": "#/components/schemas/User"
},
"flags": {
"type": "integer",
"default": 0
},
"redirect_uris": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"rpc_application_state": {
"type": "integer",
"default": 0
},
"store_application_state": {
"type": "integer",
"default": 1
},
"verification_state": {
"type": "integer",
"default": 1
},
"interactions_endpoint_url": {
"type": "string"
},
"integration_public": {
"type": "boolean",
"default": true
},
"integration_require_code_grant": {
"type": "boolean",
"default": false
},
"discoverability_state": {
"type": "integer",
"default": 1
},
"discovery_eligibility_flags": {
"type": "integer",
"default": 2240
},
"bot": {
"$ref": "#/components/schemas/User"
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"cover_image": {
"type": "string"
},
"install_params": {
"type": "object",
"properties": {
"scopes": {
"type": "array",
"items": {
"type": "string"
}
},
"permissions": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"permissions",
"scopes"
]
},
"terms_of_service_url": {
"type": "string"
},
"privacy_policy_url": {
"type": "string"
},
"team": {
"$ref": "#/components/schemas/Team"
},
"id": {
"type": "string"
}
},
"required": [
"description",
"discoverability_state",
"discovery_eligibility_flags",
"flags",
"hook",
"id",
"integration_public",
"integration_require_code_grant",
"name",
"owner",
"redirect_uris",
"rpc_application_state",
"store_application_state",
"summary",
"verification_state",
"verify_key"
]
},
"Team": {
"type": "object",
"properties": {
"icon": {
"type": "string"
},
"members": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TeamMember"
}
},
"name": {
"type": "string"
},
"owner_user_id": {
"type": "string"
},
"owner_user": {
"$ref": "#/components/schemas/User"
},
"id": {
"type": "string"
}
},
"required": [
"id",
"members",
"name",
"owner_user",
"owner_user_id"
]
},
"TeamMember": {
"type": "object",
"properties": {
"membership_state": {
"$ref": "#/components/schemas/TeamMemberState"
},
"permissions": {
"type": "array",
"items": {
"type": "string"
}
},
"team_id": {
"type": "string"
},
"team": {
"$ref": "#/components/schemas/Team"
},
"user_id": {
"type": "string"
},
"user": {
"$ref": "#/components/schemas/User"
},
"id": {
"type": "string"
}
},
"required": [
"id",
"membership_state",
"permissions",
"team",
"team_id",
"user",
"user_id"
]
},
"TeamMemberState": {
"enum": [
1,
2
],
"type": "number"
},
"Sticker": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"available": {
"type": "boolean"
},
"tags": {
"type": "string"
},
"pack_id": {
"type": "string"
},
"pack": {
"$ref": "#/components/schemas/StickerPack"
},
"guild_id": {
"type": "string"
},
"guild": {
"$ref": "#/components/schemas/Guild"
},
"user_id": {
"type": "string"
},
"user": {
"$ref": "#/components/schemas/User"
},
"type": {
"$ref": "#/components/schemas/StickerType"
},
"format_type": {
"$ref": "#/components/schemas/StickerFormatType"
},
"id": {
"type": "string"
}
},
"required": [
"format_type",
"id",
"name",
"pack",
"type"
]
},
"StickerPack": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"banner_asset_id": {
"type": "string"
},
"stickers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Sticker"
}
},
"cover_sticker_id": {
"type": "string"
},
"cover_sticker": {
"$ref": "#/components/schemas/Sticker"
},
"id": {
"type": "string"
}
},
"required": [
"id",
"name",
"stickers"
]
},
"StickerType": {
"enum": [
1,
2
],
"type": "number"
},
"StickerFormatType": {
"enum": [
0,
1,
2,
3
],
"type": "number"
},
"Attachment_1": {
"type": "object",
"properties": {
"filename": {
"type": "string"
},
"size": {
"type": "integer"
},
"url": {
"type": "string"
},
"proxy_url": {
"type": "string"
},
"height": {
"type": "integer"
},
"width": {
"type": "integer"
},
"content_type": {
"type": "string"
},
"message_id": {
"type": "string"
},
"message": {
"$ref": "#/components/schemas/Message"
},
"id": {
"type": "string"
}
},
"required": [
"filename",
"id",
"message",
"message_id",
"proxy_url",
"size",
"url"
]
},
"Reaction": {
"type": "object",
"properties": {
"count": {
"type": "integer"
},
"emoji": {
"$ref": "#/components/schemas/PartialEmoji"
},
"user_ids": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"count",
"emoji",
"user_ids"
]
},
"PartialEmoji": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"animated": {
"type": "boolean"
}
},
"required": [
"name"
]
},
"MessageType": {
"enum": [
0,
1,
10,
11,
12,
13,
14,
15,
16,
19,
2,
20,
255,
3,
4,
41,
42,
43,
5,
50,
6,
63,
7,
8,
9
],
"type": "number"
},
"InteractionType": {
"enum": [
0,
1,
2
],
"type": "number"
},
"MessageComponent": {
"type": "object",
"properties": {
"type": {
"type": "integer"
},
"style": {
"type": "integer"
},
"label": {
"type": "string"
},
"emoji": {
"$ref": "#/components/schemas/PartialEmoji"
},
"custom_id": {
"type": "string"
},
"url": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"components": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MessageComponent"
}
}
},
"required": [
"components",
"type"
]
},
"VoiceState": {
"type": "object",
"properties": {
"guild_id": {
"type": "string"
},
"guild": {
"$ref": "#/components/schemas/Guild"
},
"channel_id": {
"type": "string"
},
"channel": {
"$ref": "#/components/schemas/Channel"
},
"user_id": {
"type": "string"
},
"user": {
"$ref": "#/components/schemas/User"
},
"member": {
"$ref": "#/components/schemas/Member"
},
"session_id": {
"type": "string"
},
"token": {
"type": "string"
},
"deaf": {
"type": "boolean"
},
"mute": {
"type": "boolean"
},
"self_deaf": {
"type": "boolean"
},
"self_mute": {
"type": "boolean"
},
"self_stream": {
"type": "boolean"
},
"self_video": {
"type": "boolean"
},
"suppress": {
"type": "boolean"
},
"request_to_speak_timestamp": {
"type": "string",
"format": "date-time"
},
"id": {
"type": "string"
}
},
"required": [
"channel",
"channel_id",
"deaf",
"guild_id",
"id",
"member",
"mute",
"self_deaf",
"self_mute",
"self_video",
"session_id",
"suppress",
"token",
"user",
"user_id"
]
},
"ReadState": {
"type": "object",
"properties": {
"channel_id": {
"type": "string"
},
"channel": {
"$ref": "#/components/schemas/Channel"
},
"user_id": {
"type": "string"
},
"user": {
"$ref": "#/components/schemas/User"
},
"last_message_id": {
"type": "string"
},
"public_ack": {
"type": "string"
},
"notifications_cursor": {
"type": "string"
},
"last_pin_timestamp": {
"type": "string",
"format": "date-time"
},
"mention_count": {
"type": "integer"
},
"manual": {
"type": "boolean"
},
"id": {
"type": "string"
}
},
"required": [
"channel",
"channel_id",
"id",
"last_message_id",
"manual",
"mention_count",
"notifications_cursor",
"public_ack",
"user",
"user_id"
]
},
"Ban": {
"type": "object",
"properties": {
"user_id": {
"type": "string"
},
"user": {
"$ref": "#/components/schemas/User"
},
"guild_id": {
"type": "string"
},
"guild": {
"$ref": "#/components/schemas/Guild"
},
"executor_id": {
"type": "string"
},
"executor": {
"$ref": "#/components/schemas/User"
},
"ip": {
"type": "string"
},
"reason": {
"type": "string"
},
"id": {
"type": "string"
}
},
"required": [
"executor",
"executor_id",
"guild",
"guild_id",
"id",
"ip",
"user",
"user_id"
]
},
"Template": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"usage_count": {
"type": "integer"
},
"creator_id": {
"type": "string"
},
"creator": {
"$ref": "#/components/schemas/User"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
},
"source_guild_id": {
"type": "string"
},
"source_guild": {
"$ref": "#/components/schemas/Guild"
},
"serialized_source_guild": {
"$ref": "#/components/schemas/Guild"
},
"id": {
"type": "string"
}
},
"required": [
"code",
"created_at",
"creator",
"creator_id",
"id",
"name",
"serialized_source_guild",
"source_guild",
"source_guild_id",
"updated_at"
]
},
"Emoji": {
"type": "object",
"properties": {
"animated": {
"type": "boolean"
},
"available": {
"type": "boolean"
},
"guild_id": {
"type": "string"
},
"guild": {
"$ref": "#/components/schemas/Guild"
},
"user_id": {
"type": "string"
},
"user": {
"$ref": "#/components/schemas/User"
},
"managed": {
"type": "boolean"
},
"name": {
"type": "string"
},
"require_colons": {
"type": "boolean"
},
"roles": {
"type": "array",
"items": {
"type": "string"
}
},
"groups": {
"type": "array",
"items": {
"type": "string"
}
},
"id": {
"type": "string"
}
},
"required": [
"animated",
"available",
"groups",
"guild",
"guild_id",
"id",
"managed",
"name",
"require_colons",
"roles",
"user",
"user_id"
]
},
"GuildWelcomeScreen": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"description": {
"type": "string"
},
"welcome_channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"emoji_id": {
"type": "string"
},
"emoji_name": {
"type": "string"
},
"channel_id": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"channel_id",
"description"
]
}
}
},
"required": [
"description",
"enabled",
"welcome_channels"
]
},
"GuildMessagesSearchMessage": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/MessageType"
},
"content": {
"type": "string"
},
"channel_id": {
"type": "string"
},
"author": {
"$ref": "#/components/schemas/PublicUser"
},
"attachments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Attachment_1"
}
},
"embeds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Embed"
}
},
"mentions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PublicUser"
}
},
"mention_roles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Role"
}
},
"pinned": {
"type": "boolean"
},
"mention_everyone": {
"type": "boolean"
},
"tts": {
"type": "boolean"
},
"timestamp": {
"type": "string"
},
"edited_timestamp": {
"type": "string",
"nullable": true
},
"flags": {
"type": "integer"
},
"components": {
"type": "array",
"items": {}
},
"hit": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"attachments",
"author",
"channel_id",
"components",
"edited_timestamp",
"embeds",
"flags",
"hit",
"id",
"mention_roles",
"mentions",
"pinned",
"timestamp",
"tts",
"type"
]
},
"PublicUser": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"premium_since": {
"type": "string",
"format": "date-time"
},
"username": {
"type": "string"
},
"discriminator": {
"type": "string"
},
"public_flags": {
"type": "integer"
},
"avatar": {
"type": "string"
},
"accent_color": {
"type": "integer"
},
"banner": {
"type": "string"
},
"bio": {
"type": "string"
},
"bot": {
"type": "boolean"
},
"premium_type": {
"type": "integer"
},
"theme_colors": {
"type": "array",
"items": {
"type": "integer"
}
},
"pronouns": {
"type": "string"
}
},
"required": [
"bio",
"bot",
"discriminator",
"id",
"premium_since",
"premium_type",
"public_flags",
"username"
]
},
"GuildVanityUrl": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"uses": {
"type": "integer"
}
},
"required": [
"code",
"uses"
]
},
"GuildVanityUrlNoInvite": {
"type": "object",
"properties": {
"code": {
"type": "null"
}
},
"required": [
"code"
]
},
"ClientStatus": {
"type": "object",
"properties": {
"desktop": {
"type": "string"
},
"mobile": {
"type": "string"
},
"web": {
"type": "string"
}
}
},
"Snowflake": {
"description": "A container for useful snowflake-related methods.",
"type": "object"
},
"TenorGifResponse": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"url": {
"type": "string"
},
"src": {
"type": "string"
},
"gif_src": {
"type": "string"
},
"width": {
"type": "integer"
},
"height": {
"type": "integer"
},
"preview": {
"type": "string"
}
},
"required": [
"gif_src",
"height",
"id",
"preview",
"src",
"title",
"url",
"width"
]
},
"BackupCode": {
"type": "object",
"properties": {
"user": {
"$ref": "#/components/schemas/User"
},
"code": {
"type": "string"
},
"consumed": {
"type": "boolean"
},
"expired": {
"type": "boolean"
},
"id": {
"type": "string"
}
},
"required": [
"code",
"consumed",
"expired",
"id",
"user"
]
},
"APIGuild": {
"type": "object",
"properties": {
"reload": {
"description": "Reloads entity data from the database.",
"type": "object",
"additionalProperties": false
},
"id": {
"type": "string"
},
"roles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Role"
}
},
"name": {
"type": "string"
},
"banner": {
"type": "string"
},
"unavailable": {
"type": "boolean"
},
"channels": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Channel"
}
},
"region": {
"type": "string"
},
"icon": {
"type": "string"
},
"system_channel_id": {
"type": "string"
},
"rules_channel_id": {
"type": "string"
},
"afk_timeout": {
"type": "integer"
},
"explicit_content_filter": {
"type": "integer"
},
"assign": {
"type": "object",
"additionalProperties": false
},
"toJSON": {
"type": "object",
"additionalProperties": false
},
"hasId": {
"description": "Checks if entity has an id.\nIf entity composite compose ids, it will check them all.",
"type": "object",
"additionalProperties": false
},
"save": {
"description": "Saves current entity in the database.\nIf entity does not exist in the database then inserts, otherwise updates.",
"type": "object",
"additionalProperties": false
},
"remove": {
"description": "Removes current entity from the database.",
"type": "object",
"additionalProperties": false
},
"softRemove": {
"description": "Records the delete date of current entity.",
"type": "object",
"additionalProperties": false
},
"recover": {
"description": "Recovers a given entity in the database.",
"type": "object",
"additionalProperties": false
},
"afk_channel_id": {
"type": "string"
},
"bans": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Ban"
}
},
"default_message_notifications": {
"type": "integer"
},
"description": {
"type": "string"
},
"discovery_splash": {
"type": "string"
},
"features": {
"type": "array",
"items": {
"type": "string"
}
},
"primary_category_id": {
"type": "string"
},
"large": {
"type": "boolean"
},
"max_members": {
"type": "integer"
},
"max_presences": {
"type": "integer"
},
"max_video_channel_users": {
"type": "integer"
},
"member_count": {
"type": "integer"
},
"presence_count": {
"type": "integer"
},
"members": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Member"
}
},
"template_id": {
"type": "string"
},
"emojis": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Emoji"
}
},
"stickers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Sticker"
}
},
"invites": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Invite"
}
},
"voice_states": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VoiceState"
}
},
"webhooks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Webhook"
}
},
"mfa_level": {
"type": "integer"
},
"owner_id": {
"type": "string"
},
"preferred_locale": {
"type": "string"
},
"premium_subscription_count": {
"type": "integer"
},
"premium_tier": {
"type": "integer"
},
"public_updates_channel_id": {
"type": "string"
},
"splash": {
"type": "string"
},
"system_channel_flags": {
"type": "integer"
},
"verification_level": {
"type": "integer"
},
"welcome_screen": {
"$ref": "#/components/schemas/GuildWelcomeScreen"
},
"widget_channel_id": {
"type": "string"
},
"widget_enabled": {
"type": "boolean"
},
"nsfw_level": {
"type": "integer"
},
"nsfw": {
"type": "boolean"
},
"parent": {
"type": "string"
},
"permissions": {
"type": "integer"
},
"premium_progress_bar_enabled": {
"type": "boolean"
},
"_do_validate": {
"type": "object",
"additionalProperties": false
}
},
"required": [
"_do_validate",
"assign",
"bans",
"channels",
"emojis",
"features",
"hasId",
"id",
"invites",
"members",
"name",
"nsfw",
"premium_progress_bar_enabled",
"public_updates_channel_id",
"recover",
"reload",
"remove",
"roles",
"save",
"softRemove",
"stickers",
"toJSON",
"unavailable",
"voice_states",
"webhooks",
"welcome_screen",
"widget_enabled"
]
},
"DmChannelDTO": {
"type": "object",
"properties": {
"icon": {
"type": "string",
"nullable": true
},
"id": {
"type": "string"
},
"last_message_id": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"origin_channel_id": {
"type": "string",
"nullable": true
},
"owner_id": {
"type": "string"
},
"recipients": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MinimalPublicUserDTO"
}
},
"type": {
"type": "integer"
}
},
"required": [
"icon",
"id",
"last_message_id",
"name",
"origin_channel_id",
"recipients",
"type"
]
},
"MinimalPublicUserDTO": {
"type": "object",
"properties": {
"avatar": {
"type": "string",
"nullable": true
},
"discriminator": {
"type": "string"
},
"id": {
"type": "string"
},
"public_flags": {
"type": "integer"
},
"username": {
"type": "string"
}
},
"required": [
"discriminator",
"id",
"public_flags",
"username"
]
},
"Categories": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"localizations": {
"type": "string"
},
"is_primary": {
"type": "boolean"
}
},
"required": [
"id",
"is_primary",
"localizations",
"name"
]
},
"GuildVoiceRegion": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"custom": {
"type": "boolean"
},
"deprecated": {
"type": "boolean"
},
"optimal": {
"type": "boolean"
}
},
"required": [
"custom",
"deprecated",
"id",
"name",
"optimal"
]
},
"UserLimits": {
"type": "object",
"properties": {
"maxGuilds": {
"type": "integer",
"default": 1048576
},
"maxUsername": {
"type": "integer",
"default": 32
},
"maxFriends": {
"type": "integer",
"default": 5000
}
},
"required": [
"maxFriends",
"maxGuilds",
"maxUsername"
]
},
"GuildLimits": {
"type": "object",
"properties": {
"maxRoles": {
"type": "integer",
"default": 1000
},
"maxEmojis": {
"type": "integer",
"default": 2000
},
"maxMembers": {
"type": "integer",
"default": 25000000
},
"maxChannels": {
"type": "integer",
"default": 65535
},
"maxChannelsInCategory": {
"type": "integer",
"default": 65535
}
},
"required": [
"maxChannels",
"maxChannelsInCategory",
"maxEmojis",
"maxMembers",
"maxRoles"
]
},
"MessageLimits": {
"type": "object",
"properties": {
"maxCharacters": {
"type": "integer",
"default": 1048576
},
"maxTTSCharacters": {
"type": "integer",
"default": 160
},
"maxReactions": {
"type": "integer",
"default": 2048
},
"maxAttachmentSize": {
"type": "integer",
"default": 1073741824
},
"maxBulkDelete": {
"type": "integer",
"default": 1000
},
"maxEmbedDownloadSize": {
"type": "integer",
"default": 5242880
}
},
"required": [
"maxAttachmentSize",
"maxBulkDelete",
"maxCharacters",
"maxEmbedDownloadSize",
"maxReactions",
"maxTTSCharacters"
]
},
"ChannelLimits": {
"type": "object",
"properties": {
"maxPins": {
"type": "integer",
"default": 500
},
"maxTopic": {
"type": "integer",
"default": 1024
},
"maxWebhooks": {
"type": "integer",
"default": 100
}
},
"required": [
"maxPins",
"maxTopic",
"maxWebhooks"
]
},
"RateLimits": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": false
},
"ip": {
"$ref": "#/components/schemas/RateLimitOptions"
},
"global": {
"$ref": "#/components/schemas/RateLimitOptions"
},
"error": {
"$ref": "#/components/schemas/RateLimitOptions"
},
"routes": {
"$ref": "#/components/schemas/RouteRateLimit"
}
},
"required": [
"enabled",
"error",
"global",
"ip",
"routes"
]
},
"RateLimitOptions": {
"type": "object",
"properties": {
"bot": {
"type": "integer"
},
"count": {
"type": "integer"
},
"window": {
"type": "integer"
},
"onyIp": {
"type": "boolean"
}
},
"required": [
"count",
"window"
]
},
"RouteRateLimit": {
"type": "object",
"properties": {
"guild": {
"$ref": "#/components/schemas/RateLimitOptions"
},
"webhook": {
"$ref": "#/components/schemas/RateLimitOptions"
},
"channel": {
"$ref": "#/components/schemas/RateLimitOptions"
},
"auth": {}
},
"required": [
"auth",
"channel",
"guild",
"webhook"
]
},
"GlobalRateLimits": {
"type": "object",
"properties": {
"register": {
"$ref": "#/components/schemas/GlobalRateLimit"
},
"sendMessage": {
"$ref": "#/components/schemas/GlobalRateLimit"
}
},
"required": [
"register",
"sendMessage"
]
},
"GlobalRateLimit": {
"type": "object",
"properties": {
"limit": {
"type": "integer",
"default": 100
},
"window": {
"type": "integer",
"default": 3600000
},
"enabled": {
"type": "boolean",
"default": true
}
},
"required": [
"enabled",
"limit",
"window"
]
},
"PublicConnectedAccount": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"name": {
"type": "string"
},
"verified": {
"type": "boolean"
}
},
"required": [
"name",
"type"
]
},
"TokenResponse": {
"type": "object",
"properties": {
"token": {
"type": "string"
},
"settings": {
"$ref": "#/components/schemas/UserSettings"
}
},
"required": [
"settings",
"token"
]
},
"MFAResponse": {
"type": "object",
"properties": {
"ticket": {
"type": "string"
},
"mfa": {
"type": "boolean",
"enum": [
true
]
},
"sms": {
"type": "boolean",
"enum": [
false
]
},
"token": {
"type": "null"
}
},
"required": [
"mfa",
"sms",
"ticket",
"token"
]
},
"WebAuthnResponse": {
"type": "object",
"properties": {
"webauthn": {
"type": "string"
},
"ticket": {
"type": "string"
},
"mfa": {
"type": "boolean",
"enum": [
true
]
},
"sms": {
"type": "boolean",
"enum": [
false
]
},
"token": {
"type": "null"
}
},
"required": [
"mfa",
"sms",
"ticket",
"token",
"webauthn"
]
},
"ChannelPermissionOverwriteSchema": {
"type": "object",
"properties": {
"allow": {
"type": "string"
},
"deny": {
"type": "string"
},
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ChannelPermissionOverwriteType"
}
},
"required": [
"allow",
"deny",
"id",
"type"
]
},
"ChannelReorderSchema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"position": {
"type": "integer"
},
"lock_permissions": {
"type": "boolean"
},
"parent_id": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
}
},
"CodesVerificationSchema": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"nonce": {
"type": "string"
},
"regenerate": {
"type": "boolean"
}
},
"required": [
"key",
"nonce"
]
},
"ConnectedAccountSchema": {
"type": "object",
"properties": {
"external_id": {
"type": "string"
},
"user_id": {
"type": "string"
},
"token_data": {
"$ref": "#/components/schemas/ConnectedAccountTokenData"
},
"friend_sync": {
"type": "boolean"
},
"name": {
"type": "string"
},
"revoked": {
"type": "boolean"
},
"show_activity": {
"type": "integer"
},
"type": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"visibility": {
"type": "integer"
},
"integrations": {
"type": "array",
"items": {
"type": "string"
}
},
"metadata_": {},
"metadata_visibility": {
"type": "integer"
},
"two_way_link": {
"type": "boolean"
}
},
"required": [
"external_id",
"name",
"type",
"user_id"
]
},
"ConnectionCallbackSchema": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"state": {
"type": "string"
},
"insecure": {
"type": "boolean"
},
"friend_sync": {
"type": "boolean"
},
"openid_params": {}
},
"required": [
"friend_sync",
"insecure",
"state"
]
},
"ConnectionUpdateSchema": {
"type": "object",
"properties": {
"visibility": {
"type": "boolean"
},
"show_activity": {
"type": "boolean"
},
"metadata_visibility": {
"type": "boolean"
}
}
},
"DmChannelCreateSchema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"recipients": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"recipients"
]
},
"EmojiCreateSchema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"image": {
"type": "string"
},
"require_colons": {
"type": "boolean",
"nullable": true
},
"roles": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"image"
]
},
"EmojiModifySchema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"roles": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ForgotPasswordSchema": {
"type": "object",
"properties": {
"login": {
"type": "string"
},
"captcha_key": {
"type": "string"
}
},
"required": [
"login"
]
},
"GuildCreateSchema": {
"type": "object",
"properties": {
"name": {
"maxLength": 100,
"type": "string"
},
"region": {
"type": "string"
},
"icon": {
"type": "string",
"nullable": true
},
"channels": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChannelModifySchema"
}
},
"guild_template_code": {
"type": "string"
},
"system_channel_id": {
"type": "string"
},
"rules_channel_id": {
"type": "string"
}
}
},
"GuildTemplateCreateSchema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"avatar": {
"type": "string",
"nullable": true
}
},
"required": [
"name"
]
},
"GuildUpdateSchema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"banner": {
"type": "string",
"nullable": true
},
"splash": {
"type": "string",
"nullable": true
},
"description": {
"type": "string"
},
"features": {
"type": "array",
"items": {
"type": "string"
}
},
"verification_level": {
"type": "integer"
},
"default_message_notifications": {
"type": "integer"
},
"system_channel_flags": {
"type": "integer"
},
"explicit_content_filter": {
"type": "integer"
},
"public_updates_channel_id": {
"type": "string"
},
"afk_timeout": {
"type": "integer"
},
"afk_channel_id": {
"type": "string"
},
"preferred_locale": {
"type": "string"
},
"premium_progress_bar_enabled": {
"type": "boolean"
},
"discovery_splash": {
"type": "string"
},
"region": {
"type": "string"
},
"icon": {
"type": "string",
"nullable": true
},
"guild_template_code": {
"type": "string"
},
"system_channel_id": {
"type": "string"
},
"rules_channel_id": {
"type": "string"
}
}
},
"GuildUpdateWelcomeScreenSchema": {
"type": "object",
"properties": {
"welcome_channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"channel_id": {
"type": "string"
},
"description": {
"type": "string"
},
"emoji_id": {
"type": "string"
},
"emoji_name": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"channel_id",
"description"
]
}
},
"enabled": {
"type": "boolean"
},
"description": {
"type": "string"
}
}
},
"IdentifySchema": {
"type": "object",
"properties": {
"token": {
"type": "string"
},
"properties": {
"type": "object",
"properties": {
"os": {
"type": "string"
},
"os_atch": {
"type": "string"
},
"browser": {
"type": "string"
},
"device": {
"type": "string"
},
"$os": {
"type": "string"
},
"$browser": {
"type": "string"
},
"$device": {
"type": "string"
},
"browser_user_agent": {
"type": "string"
},
"browser_version": {
"type": "string"
},
"os_version": {
"type": "string"
},
"referrer": {
"type": "string"
},
"referring_domain": {
"type": "string"
},
"referrer_current": {
"type": "string"
},
"referring_domain_current": {
"type": "string"
},
"release_channel": {
"enum": [
"canary",
"dev",
"ptb",
"stable"
],
"type": "string"
},
"client_build_number": {
"type": "integer"
},
"client_event_source": {
"type": "string"
},
"client_version": {
"type": "string"
},
"system_locale": {
"type": "string"
}
},
"additionalProperties": false
},
"intents": {
"type": "number"
},
"presence": {
"$ref": "#/components/schemas/ActivitySchema"
},
"compress": {
"type": "boolean"
},
"large_threshold": {
"type": "integer"
},
"largeThreshold": {
"type": "integer"
},
"shard": {
"minItems": 2,
"maxItems": 2,
"type": "array",
"items": {
"type": "number"
}
},
"guild_subscriptions": {
"type": "boolean"
},
"capabilities": {
"type": "integer"
},
"client_state": {
"type": "object",
"properties": {
"guild_hashes": {},
"highest_last_message_id": {
"type": [
"string",
"integer"
]
},
"read_state_version": {
"type": "integer"
},
"user_guild_settings_version": {
"type": "integer"
},
"user_settings_version": {
"type": "integer"
},
"useruser_guild_settings_version": {
"type": "integer"
},
"private_channels_version": {
"type": "integer"
},
"guild_versions": {},
"api_code_version": {
"type": "integer"
}
},
"additionalProperties": false
},
"clientState": {
"type": "object",
"properties": {
"guildHashes": {},
"highestLastMessageId": {
"type": [
"string",
"integer"
]
},
"readStateVersion": {
"type": "integer"
},
"userGuildSettingsVersion": {
"type": "integer"
},
"useruserGuildSettingsVersion": {
"type": "integer"
},
"guildVersions": {},
"apiCodeVersion": {
"type": "integer"
}
},
"additionalProperties": false
},
"v": {
"type": "integer"
}
},
"required": [
"properties",
"token"
]
},
"InviteCreateSchema": {
"type": "object",
"properties": {
"target_user_id": {
"type": "string"
},
"target_type": {
"type": "string"
},
"validate": {
"type": "string"
},
"max_age": {
"type": "integer"
},
"max_uses": {
"type": "integer"
},
"temporary": {
"type": "boolean"
},
"unique": {
"type": "boolean"
},
"target_user": {
"type": "string"
},
"target_user_type": {
"type": "integer"
}
}
},
"LazyRequestSchema": {
"type": "object",
"properties": {
"guild_id": {
"type": "string"
},
"channels": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "integer"
}
}
}
},
"activities": {
"type": "boolean"
},
"threads": {
"type": "boolean"
},
"typing": {
"enum": [
true
],
"type": "boolean"
},
"members": {
"type": "array",
"items": {
"type": "string"
}
},
"thread_member_lists": {
"type": "array",
"items": {}
}
},
"required": [
"guild_id"
]
},
"LoginSchema": {
"type": "object",
"properties": {
"login": {
"type": "string"
},
"password": {
"type": "string"
},
"undelete": {
"type": "boolean"
},
"captcha_key": {
"type": "string"
},
"login_source": {
"type": "string"
},
"gift_code_sku_id": {
"type": "string"
}
},
"required": [
"login",
"password"
]
},
"MemberChangeProfileSchema": {
"type": "object",
"properties": {
"banner": {
"type": "string",
"nullable": true
},
"nick": {
"type": "string"
},
"bio": {
"type": "string"
},
"pronouns": {
"type": "string"
},
"theme_colors": {
"minItems": 2,
"maxItems": 2,
"type": "array",
"items": {
"type": "integer"
}
}
}
},
"MemberChangeSchema": {
"type": "object",
"properties": {
"roles": {
"type": "array",
"items": {
"type": "string"
}
},
"nick": {
"type": "string"
},
"avatar": {
"type": "string",
"nullable": true
},
"bio": {
"type": "string"
}
}
},
"MessageAcknowledgeSchema": {
"type": "object",
"properties": {
"manual": {
"type": "boolean"
},
"mention_count": {
"type": "integer"
}
}
},
"MessageCreateSchema": {
"type": "object",
"properties": {
"type": {
"type": "integer"
},
"content": {
"type": "string"
},
"nonce": {
"type": "string"
},
"channel_id": {
"type": "string"
},
"tts": {
"type": "boolean"
},
"flags": {
"type": "string"
},
"embeds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Embed"
}
},
"embed": {
"$ref": "#/components/schemas/Embed"
},
"allowed_mentions": {
"type": "object",
"properties": {
"parse": {
"type": "array",
"items": {
"type": "string"
}
},
"roles": {
"type": "array",
"items": {
"type": "string"
}
},
"users": {
"type": "array",
"items": {
"type": "string"
}
},
"replied_user": {
"type": "boolean"
}
},
"additionalProperties": false
},
"message_reference": {
"type": "object",
"properties": {
"message_id": {
"type": "string"
},
"channel_id": {
"type": "string"
},
"guild_id": {
"type": "string"
},
"fail_if_not_exists": {
"type": "boolean"
}
},
"additionalProperties": false,
"required": [
"channel_id",
"message_id"
]
},
"payload_json": {
"type": "string"
},
"file": {
"type": "object",
"properties": {
"filename": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"filename"
]
},
"attachments": {
"description": "TODO: we should create an interface for attachments\nTODO: OpenWAAO<-->attachment-style metadata conversion",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"filename": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"filename",
"id"
]
}
},
"sticker_ids": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"MessageEditSchema": {
"type": "object",
"properties": {
"file": {
"type": "object",
"properties": {
"filename": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"filename"
]
},
"embed": {
"$ref": "#/components/schemas/Embed"
},
"flags": {
"type": "string"
},
"content": {
"type": "string"
},
"nonce": {
"type": "string"
},
"channel_id": {
"type": "string"
},
"tts": {
"type": "boolean"
},
"embeds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Embed"
}
},
"allowed_mentions": {
"type": "object",
"properties": {
"parse": {
"type": "array",
"items": {
"type": "string"
}
},
"roles": {
"type": "array",
"items": {
"type": "string"
}
},
"users": {
"type": "array",
"items": {
"type": "string"
}
},
"replied_user": {
"type": "boolean"
}
},
"additionalProperties": false
},
"message_reference": {
"type": "object",
"properties": {
"message_id": {
"type": "string"
},
"channel_id": {
"type": "string"
},
"guild_id": {
"type": "string"
},
"fail_if_not_exists": {
"type": "boolean"
}
},
"additionalProperties": false,
"required": [
"channel_id",
"message_id"
]
},
"payload_json": {
"type": "string"
},
"attachments": {
"description": "TODO: we should create an interface for attachments\nTODO: OpenWAAO<-->attachment-style metadata conversion",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"filename": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"filename",
"id"
]
}
},
"sticker_ids": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"MfaCodesSchema": {
"type": "object",
"properties": {
"password": {
"type": "string"
},
"regenerate": {
"type": "boolean"
}
},
"required": [
"password"
]
},
"ModifyGuildStickerSchema": {
"type": "object",
"properties": {
"name": {
"minLength": 2,
"maxLength": 30,
"type": "string"
},
"description": {
"maxLength": 100,
"type": "string"
},
"tags": {
"maxLength": 200,
"type": "string"
}
},
"required": [
"name",
"tags"
]
},
"PasswordResetSchema": {
"type": "object",
"properties": {
"password": {
"type": "string"
},
"token": {
"type": "string"
}
},
"required": [
"password",
"token"
]
},
"PurgeSchema": {
"type": "object",
"properties": {
"before": {
"type": "string"
},
"after": {
"type": "string"
}
},
"required": [
"after",
"before"
]
},
"RegisterSchema": {
"type": "object",
"properties": {
"username": {
"minLength": 2,
"maxLength": 32,
"type": "string"
},
"password": {
"minLength": 1,
"maxLength": 72,
"type": "string"
},
"consent": {
"type": "boolean"
},
"email": {
"format": "email",
"type": "string"
},
"fingerprint": {
"type": "string"
},
"invite": {
"type": "string"
},
"date_of_birth": {
"type": "string"
},
"gift_code_sku_id": {
"type": "string"
},
"captcha_key": {
"type": "string"
},
"promotional_email_opt_in": {
"type": "boolean"
}
},
"required": [
"consent",
"username"
]
},
"RelationshipPostSchema": {
"type": "object",
"properties": {
"discriminator": {
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"discriminator",
"username"
]
},
"RelationshipPutSchema": {
"type": "object",
"properties": {
"type": {
"enum": [
1,
2,
3,
4
],
"type": "number"
}
}
},
"RoleModifySchema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"permissions": {
"type": "string"
},
"color": {
"type": "integer"
},
"hoist": {
"type": "boolean"
},
"mentionable": {
"type": "boolean"
},
"position": {
"type": "integer"
},
"icon": {
"type": "string"
},
"unicode_emoji": {
"type": "string"
}
}
},
"RolePositionUpdateSchema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"position": {
"type": "integer"
}
},
"additionalProperties": false,
"required": [
"id",
"position"
]
}
},
"SelectProtocolSchema": {
"type": "object",
"properties": {
"protocol": {
"enum": [
"udp",
"webrtc"
],
"type": "string"
},
"data": {
"anyOf": [
{
"type": "object",
"properties": {
"address": {
"type": "string"
},
"port": {
"type": "integer"
},
"mode": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"address",
"mode",
"port"
]
},
{
"type": "string"
}
]
},
"sdp": {
"type": "string"
},
"codecs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"enum": [
"H264",
"VP8",
"VP9",
"opus"
],
"type": "string"
},
"type": {
"enum": [
"audio",
"video"
],
"type": "string"
},
"priority": {
"type": "integer"
},
"payload_type": {
"type": "integer"
},
"rtx_payload_type": {
"type": [
"null",
"integer"
]
}
},
"additionalProperties": false,
"required": [
"name",
"payload_type",
"priority",
"type"
]
}
},
"rtc_connection_id": {
"type": "string"
}
},
"required": [
"data",
"protocol"
]
},
"TemplateCreateSchema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
}
},
"required": [
"name"
]
},
"TemplateModifySchema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
}
},
"required": [
"name"
]
},
"TotpDisableSchema": {
"type": "object",
"properties": {
"code": {
"type": "string"
}
},
"required": [
"code"
]
},
"TotpEnableSchema": {
"type": "object",
"properties": {
"password": {
"type": "string"
},
"code": {
"type": "string"
},
"secret": {
"type": "string"
}
},
"required": [
"password"
]
},
"TotpSchema": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"ticket": {
"type": "string"
},
"gift_code_sku_id": {
"type": "string",
"nullable": true
},
"login_source": {
"type": "string",
"nullable": true
}
},
"required": [
"code",
"ticket"
]
},
"UserDeleteSchema": {
"type": "object",
"properties": {
"user_id": {
"type": "string"
}
},
"required": [
"user_id"
]
},
"UserGuildSettingsSchema": {
"type": "object",
"properties": {
"channel_overrides": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/ChannelOverride"
}
},
"version": {
"type": "integer"
},
"guild_id": {
"type": "string",
"nullable": true
},
"flags": {
"type": "integer"
},
"message_notifications": {
"type": "integer"
},
"mobile_push": {
"type": "boolean"
},
"mute_config": {
"anyOf": [
{
"$ref": "#/components/schemas/MuteConfig"
},
{
"type": "null"
}
]
},
"muted": {
"type": "boolean"
},
"suppress_everyone": {
"type": "boolean"
},
"suppress_roles": {
"type": "boolean"
},
"mute_scheduled_events": {
"type": "boolean"
},
"hide_muted_channels": {
"type": "boolean"
},
"notify_highlights": {
"enum": [
0
],
"type": "number"
}
}
},
"UserModifySchema": {
"type": "object",
"properties": {
"username": {
"minLength": 1,
"maxLength": 100,
"type": "string"
},
"avatar": {
"type": "string",
"nullable": true
},
"bio": {
"maxLength": 1024,
"type": "string"
},
"accent_color": {
"type": "integer"
},
"banner": {
"type": "string",
"nullable": true
},
"password": {
"type": "string"
},
"new_password": {
"type": "string"
},
"code": {
"type": "string"
},
"email": {
"type": "string"
},
"discriminator": {
"minLength": 4,
"maxLength": 4,
"type": "string"
}
}
},
"UserNoteUpdateSchema": {
"type": "object",
"properties": {
"note": {
"type": "string"
}
},
"required": [
"note"
]
},
"UserProfileModifySchema": {
"type": "object",
"properties": {
"bio": {
"type": "string"
},
"accent_color": {
"type": "integer",
"nullable": true
},
"banner": {
"type": "string",
"nullable": true
},
"pronouns": {
"type": "string"
},
"theme_colors": {
"minItems": 2,
"maxItems": 2,
"type": "array",
"items": {
"type": "integer"
}
}
}
},
"UserSettingsSchema": {
"type": "object",
"properties": {
"afk_timeout": {
"type": "integer"
},
"allow_accessibility_detection": {
"type": "boolean"
},
"animate_emoji": {
"type": "boolean"
},
"animate_stickers": {
"type": "integer"
},
"contact_sync_enabled": {
"type": "boolean"
},
"convert_emoticons": {
"type": "boolean"
},
"custom_status": {
"anyOf": [
{
"$ref": "#/components/schemas/CustomStatus"
},
{
"type": "null"
}
]
},
"default_guilds_restricted": {
"type": "boolean"
},
"detect_platform_accounts": {
"type": "boolean"
},
"developer_mode": {
"type": "boolean"
},
"disable_games_tab": {
"type": "boolean"
},
"enable_tts_command": {
"type": "boolean"
},
"explicit_content_filter": {
"type": "integer"
},
"friend_source_flags": {
"$ref": "#/components/schemas/FriendSourceFlags"
},
"gateway_connected": {
"type": "boolean"
},
"gif_auto_play": {
"type": "boolean"
},
"guild_folders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GuildFolder"
}
},
"guild_positions": {
"type": "array",
"items": {
"type": "string"
}
},
"inline_attachment_media": {
"type": "boolean"
},
"inline_embed_media": {
"type": "boolean"
},
"locale": {
"type": "string"
},
"message_display_compact": {
"type": "boolean"
},
"native_phone_integration_enabled": {
"type": "boolean"
},
"render_embeds": {
"type": "boolean"
},
"render_reactions": {
"type": "boolean"
},
"restricted_guilds": {
"type": "array",
"items": {
"type": "string"
}
},
"show_current_game": {
"type": "boolean"
},
"status": {
"enum": [
"dnd",
"idle",
"invisible",
"offline",
"online"
],
"type": "string"
},
"stream_notifications_enabled": {
"type": "boolean"
},
"theme": {
"enum": [
"dark",
"light"
],
"type": "string"
},
"timezone_offset": {
"type": "integer"
}
}
},
"VanityUrlSchema": {
"type": "object",
"properties": {
"code": {
"minLength": 1,
"maxLength": 20,
"type": "string"
}
}
},
"VoiceIdentifySchema": {
"type": "object",
"properties": {
"server_id": {
"type": "string"
},
"user_id": {
"type": "string"
},
"session_id": {
"type": "string"
},
"token": {
"type": "string"
},
"video": {
"type": "boolean"
},
"streams": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"rid": {
"type": "string"
},
"quality": {
"type": "integer"
}
},
"additionalProperties": false,
"required": [
"quality",
"rid",
"type"
]
}
}
},
"required": [
"server_id",
"session_id",
"token",
"user_id"
]
},
"VoiceStateUpdateSchema": {
"type": "object",
"properties": {
"guild_id": {
"type": "string"
},
"channel_id": {
"type": "string"
},
"self_mute": {
"type": "boolean"
},
"self_deaf": {
"type": "boolean"
},
"self_video": {
"type": "boolean"
},
"preferred_region": {
"type": "string"
},
"request_to_speak_timestamp": {
"type": "string",
"format": "date-time"
},
"suppress": {
"type": "boolean"
}
},
"required": [
"self_deaf",
"self_mute"
]
},
"VoiceVideoSchema": {
"type": "object",
"properties": {
"audio_ssrc": {
"type": "integer"
},
"video_ssrc": {
"type": "integer"
},
"rtx_ssrc": {
"type": "integer"
},
"user_id": {
"type": "string"
},
"streams": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"enum": [
"audio",
"video"
],
"type": "string"
},
"rid": {
"type": "string"
},
"ssrc": {
"type": "integer"
},
"active": {
"type": "boolean"
},
"quality": {
"type": "integer"
},
"rtx_ssrc": {
"type": "integer"
},
"max_bitrate": {
"type": "integer"
},
"max_framerate": {
"type": "integer"
},
"max_resolution": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"width": {
"type": "integer"
},
"height": {
"type": "integer"
}
},
"additionalProperties": false,
"required": [
"height",
"type",
"width"
]
}
},
"additionalProperties": false,
"required": [
"active",
"max_bitrate",
"max_framerate",
"max_resolution",
"quality",
"rid",
"rtx_ssrc",
"ssrc",
"type"
]
}
}
},
"required": [
"audio_ssrc",
"video_ssrc"
]
},
"WebAuthnPostSchema": {
"anyOf": [
{
"$ref": "#/components/schemas/GenerateWebAuthnCredentialsSchema"
},
{
"$ref": "#/components/schemas/CreateWebAuthnCredentialSchema"
}
]
},
"WebAuthnTotpSchema": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"ticket": {
"type": "string"
}
},
"required": [
"code",
"ticket"
]
},
"WebhookCreateSchema": {
"type": "object",
"properties": {
"name": {
"maxLength": 80,
"type": "string"
},
"avatar": {
"type": "string"
}
},
"required": [
"name"
]
},
"WidgetModifySchema": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"channel_id": {
"type": "string"
}
},
"required": [
"channel_id",
"enabled"
]
},
"APIErrorOrCaptchaResponse": {
"anyOf": [
{
"$ref": "#/components/schemas/APIErrorResponse"
},
{
"$ref": "#/components/schemas/CaptchaRequiredResponse"
}
]
},
"BackupCodesChallengeResponse": {
"type": "object",
"properties": {
"nonce": {
"type": "string"
},
"regenerate_nonce": {
"type": "string"
}
},
"required": [
"nonce",
"regenerate_nonce"
]
},
"DiscoverableGuildsResponse": {
"type": "object",
"properties": {
"total": {
"type": "integer"
},
"guilds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Guild"
}
},
"offset": {
"type": "integer"
},
"limit": {
"type": "integer"
}
},
"required": [
"guilds",
"limit",
"offset",
"total"
]
},
"GatewayBotResponse": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"shards": {
"type": "integer"
},
"session_start_limit": {
"type": "object",
"properties": {
"total": {
"type": "integer"
},
"remaining": {
"type": "integer"
},
"reset_after": {
"type": "integer"
},
"max_concurrency": {
"type": "integer"
}
},
"additionalProperties": false,
"required": [
"max_concurrency",
"remaining",
"reset_after",
"total"
]
}
},
"required": [
"session_start_limit",
"shards",
"url"
]
},
"GatewayResponse": {
"type": "object",
"properties": {
"url": {
"type": "string"
}
},
"required": [
"url"
]
},
"GenerateRegistrationTokensResponse": {
"type": "object",
"properties": {
"tokens": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"tokens"
]
},
"GuildBansResponse": {
"type": "object",
"properties": {
"reason": {
"type": "string"
},
"user": {
"type": "object",
"properties": {
"username": {
"type": "string"
},
"discriminator": {
"type": "string"
},
"id": {
"type": "string"
},
"avatar": {
"type": [
"null",
"string"
]
},
"public_flags": {
"type": "integer"
}
},
"additionalProperties": false,
"required": [
"avatar",
"discriminator",
"id",
"public_flags",
"username"
]
}
},
"required": [
"reason",
"user"
]
},
"GuildCreateResponse": {
"type": "object",
"properties": {
"id": {
"type": "string"
}
},
"required": [
"id"
]
},
"GuildDiscoveryRequirementsResponse": {
"type": "object",
"properties": {
"uild_id": {
"type": "string"
},
"safe_environment": {
"type": "boolean"
},
"healthy": {
"type": "boolean"
},
"health_score_pending": {
"type": "boolean"
},
"size": {
"type": "boolean"
},
"nsfw_properties": {},
"protected": {
"type": "boolean"
},
"sufficient": {
"type": "boolean"
},
"sufficient_without_grace_period": {
"type": "boolean"
},
"valid_rules_channel": {
"type": "boolean"
},
"retention_healthy": {
"type": "boolean"
},
"engagement_healthy": {
"type": "boolean"
},
"age": {
"type": "boolean"
},
"minimum_age": {
"type": "integer"
},
"health_score": {
"type": "object",
"properties": {
"avg_nonnew_participators": {
"type": "integer"
},
"avg_nonnew_communicators": {
"type": "integer"
},
"num_intentful_joiners": {
"type": "integer"
},
"perc_ret_w1_intentful": {
"type": "integer"
}
},
"additionalProperties": false,
"required": [
"avg_nonnew_communicators",
"avg_nonnew_participators",
"num_intentful_joiners",
"perc_ret_w1_intentful"
]
},
"minimum_size": {
"type": "integer"
}
},
"required": [
"age",
"engagement_healthy",
"health_score",
"health_score_pending",
"healthy",
"minimum_age",
"minimum_size",
"nsfw_properties",
"protected",
"retention_healthy",
"safe_environment",
"size",
"sufficient",
"sufficient_without_grace_period",
"uild_id",
"valid_rules_channel"
]
},
"GuildMessagesSearchResponse": {
"type": "object",
"properties": {
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GuildMessagesSearchMessage"
}
},
"total_results": {
"type": "integer"
}
},
"required": [
"messages",
"total_results"
]
},
"GuildPruneResponse": {
"type": "object",
"properties": {
"pruned": {
"type": "integer"
}
},
"required": [
"pruned"
]
},
"GuildPurgeResponse": {
"type": "object",
"properties": {
"purged": {
"type": "integer"
}
},
"required": [
"purged"
]
},
"GuildRecommendationsResponse": {
"type": "object",
"properties": {
"recommended_guilds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Guild"
}
},
"load_id": {
"type": "string"
}
},
"required": [
"load_id",
"recommended_guilds"
]
},
"GuildVanityUrlResponse": {
"anyOf": [
{
"$ref": "#/components/schemas/GuildVanityUrl"
},
{
"$ref": "#/components/schemas/GuildVanityUrlNoInvite"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GuildVanityUrl"
}
}
]
},
"GuildVanityUrlCreateResponse": {
"type": "object",
"properties": {
"code": {
"type": "string"
}
},
"required": [
"code"
]
},
"GuildWidgetJsonResponse": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"instant_invite": {
"type": "string"
},
"channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"position": {
"type": "integer"
}
},
"additionalProperties": false,
"required": [
"id",
"name",
"position"
]
}
},
"members": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"username": {
"type": "string"
},
"discriminator": {
"type": "string"
},
"avatar": {
"type": [
"null",
"string"
]
},
"status": {
"$ref": "#/components/schemas/ClientStatus"
},
"avatar_url": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"avatar",
"avatar_url",
"discriminator",
"id",
"status",
"username"
]
}
},
"presence_count": {
"type": "integer"
}
},
"required": [
"channels",
"id",
"instant_invite",
"members",
"name",
"presence_count"
]
},
"GuildWidgetSettingsResponse": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"channel_id": {
"anyOf": [
{
"$ref": "#/components/schemas/Snowflake"
},
{
"type": "null"
}
]
}
},
"required": [
"channel_id",
"enabled"
]
},
"InstanceDomainsResponse": {
"type": "object",
"properties": {
"cdn": {
"type": "string"
},
"gateway": {
"type": "string"
},
"defaultApiVersion": {
"type": "string"
},
"apiEndpoint": {
"type": "string"
}
},
"required": [
"apiEndpoint",
"cdn",
"defaultApiVersion",
"gateway"
]
},
"InstancePingResponse": {
"type": "object",
"properties": {
"ping": {
"type": "string",
"enum": [
"pong!"
]
},
"instance": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": [
"null",
"string"
]
},
"image": {
"type": [
"null",
"string"
]
},
"correspondenceEmail": {
"type": [
"null",
"string"
]
},
"correspondenceUserID": {
"type": [
"null",
"string"
]
},
"frontPage": {
"type": [
"null",
"string"
]
},
"tosPage": {
"type": [
"null",
"string"
]
}
},
"additionalProperties": false,
"required": [
"correspondenceEmail",
"correspondenceUserID",
"description",
"frontPage",
"id",
"image",
"name",
"tosPage"
]
}
},
"required": [
"instance",
"ping"
]
},
"InstanceStatsResponse": {
"type": "object",
"properties": {
"counts": {
"type": "object",
"properties": {
"user": {
"type": "integer"
},
"guild": {
"type": "integer"
},
"message": {
"type": "integer"
},
"members": {
"type": "integer"
}
},
"additionalProperties": false,
"required": [
"guild",
"members",
"message",
"user"
]
}
},
"required": [
"counts"
]
},
"LocationMetadataResponse": {
"type": "object",
"properties": {
"consent_required": {
"type": "boolean"
},
"country_code": {
"type": "string"
},
"promotional_email_opt_in": {
"type": "object",
"properties": {
"required": {
"type": "boolean",
"enum": [
true
]
},
"pre_checked": {
"type": "boolean",
"enum": [
false
]
}
},
"additionalProperties": false,
"required": [
"pre_checked",
"required"
]
}
},
"required": [
"consent_required",
"country_code",
"promotional_email_opt_in"
]
},
"MemberJoinGuildResponse": {
"type": "object",
"properties": {
"guild": {
"$ref": "#/components/schemas/Guild"
},
"emojis": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Emoji"
}
},
"roles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Role"
}
},
"stickers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Sticker"
}
}
},
"required": [
"emojis",
"guild",
"roles",
"stickers"
]
},
"OAuthAuthorizeResponse": {
"type": "object",
"properties": {
"location": {
"type": "string"
}
},
"required": [
"location"
]
},
"TenorTrendingResponse": {
"type": "object",
"properties": {
"categories": {
"type": "object",
"properties": {
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"searchterm": {
"type": "string"
},
"path": {
"type": "string"
},
"image": {
"type": "string"
},
"name": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"image",
"name",
"path",
"searchterm"
]
}
}
},
"additionalProperties": false,
"required": [
"tags"
]
},
"gifs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TenorGifResponse"
}
}
},
"required": [
"categories",
"gifs"
]
},
"TenorGifsResponse": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TenorGifResponse"
}
},
"TokenOnlyResponse": {
"type": "object",
"properties": {
"token": {
"type": "string"
}
},
"required": [
"token"
]
},
"TokenWithBackupCodesResponse": {
"type": "object",
"properties": {
"token": {
"type": "string"
},
"backup_codes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BackupCode"
}
}
},
"required": [
"backup_codes",
"token"
]
},
"APIPublicUser": {
"$ref": "#/components/schemas/PublicUser"
},
"APIPrivateUser": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"premium_since": {
"type": "string",
"format": "date-time"
},
"verified": {
"type": "boolean"
},
"username": {
"type": "string"
},
"discriminator": {
"type": "string"
},
"public_flags": {
"type": "integer"
},
"avatar": {
"type": "string"
},
"accent_color": {
"type": "integer"
},
"banner": {
"type": "string"
},
"bio": {
"type": "string"
},
"bot": {
"type": "boolean"
},
"premium_type": {
"type": "integer"
},
"theme_colors": {
"type": "array",
"items": {
"type": "integer"
}
},
"pronouns": {
"type": "string"
},
"flags": {
"type": "string"
},
"mfa_enabled": {
"type": "boolean"
},
"email": {
"type": "string"
},
"phone": {
"type": "string"
},
"nsfw_allowed": {
"type": "boolean"
},
"premium": {
"type": "boolean"
},
"purchased_flags": {
"type": "integer"
},
"premium_usage_flags": {
"type": "integer"
},
"disabled": {
"type": "boolean"
}
},
"required": [
"bio",
"bot",
"disabled",
"discriminator",
"flags",
"id",
"mfa_enabled",
"nsfw_allowed",
"premium",
"premium_since",
"premium_type",
"premium_usage_flags",
"public_flags",
"purchased_flags",
"username",
"verified"
]
},
"APIGuildArray": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIGuild"
}
},
"APIDMChannelArray": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DmChannelDTO"
}
},
"APIBackupCodeArray": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BackupCode"
}
},
"UserUpdateResponse": {
"type": "object",
"properties": {
"newToken": {
"type": "string"
},
"id": {
"type": "string"
},
"premium_since": {
"type": "string",
"format": "date-time"
},
"verified": {
"type": "boolean"
},
"username": {
"type": "string"
},
"discriminator": {
"type": "string"
},
"public_flags": {
"type": "integer"
},
"avatar": {
"type": "string"
},
"accent_color": {
"type": "integer"
},
"banner": {
"type": "string"
},
"bio": {
"type": "string"
},
"bot": {
"type": "boolean"
},
"premium_type": {
"type": "integer"
},
"theme_colors": {
"type": "array",
"items": {
"type": "integer"
}
},
"pronouns": {
"type": "string"
},
"flags": {
"type": "string"
},
"mfa_enabled": {
"type": "boolean"
},
"email": {
"type": "string"
},
"phone": {
"type": "string"
},
"nsfw_allowed": {
"type": "boolean"
},
"premium": {
"type": "boolean"
},
"purchased_flags": {
"type": "integer"
},
"premium_usage_flags": {
"type": "integer"
},
"disabled": {
"type": "boolean"
}
},
"required": [
"bio",
"bot",
"disabled",
"discriminator",
"flags",
"id",
"mfa_enabled",
"nsfw_allowed",
"premium",
"premium_since",
"premium_type",
"premium_usage_flags",
"public_flags",
"purchased_flags",
"username",
"verified"
]
},
"ApplicationDetectableResponse": {
"type": "array",
"items": {}
},
"ApplicationEntitlementsResponse": {
"type": "array",
"items": {}
},
"ApplicationSkusResponse": {
"type": "array",
"items": {}
},
"APIApplicationArray": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Application"
}
},
"APIInviteArray": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Invite"
}
},
"APIMessageArray": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Message"
}
},
"APIWebhookArray": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Webhook"
}
},
"APIDiscoveryCategoryArray": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Categories"
}
},
"APIGeneralConfiguration": {
"type": "object",
"properties": {
"instanceName": {
"type": "string",
"default": "Spacebar Instance"
},
"instanceDescription": {
"type": "string",
"default": "This is a Spacebar instance made in the pre-release days",
"nullable": true
},
"frontPage": {
"type": "string",
"default": null,
"nullable": true
},
"tosPage": {
"type": "string",
"default": null,
"nullable": true
},
"correspondenceEmail": {
"type": "string",
"default": null,
"nullable": true
},
"correspondenceUserID": {
"type": "string",
"default": null,
"nullable": true
},
"image": {
"type": "string",
"default": null,
"nullable": true
},
"instanceId": {
"type": "string"
}
},
"required": [
"correspondenceEmail",
"correspondenceUserID",
"frontPage",
"image",
"instanceDescription",
"instanceId",
"instanceName",
"tosPage"
]
},
"APIChannelArray": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Channel"
}
},
"APIEmojiArray": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Emoji"
}
},
"APIMemberArray": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Member"
}
},
"APIGuildWithJoinedAt": {
"type": "object",
"properties": {
"joined_at": {
"type": "string"
},
"afk_channel_id": {
"type": "string"
},
"afk_channel": {
"$ref": "#/components/schemas/Channel"
},
"afk_timeout": {
"type": "integer"
},
"bans": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Ban"
}
},
"banner": {
"type": "string"
},
"default_message_notifications": {
"type": "integer"
},
"description": {
"type": "string"
},
"discovery_splash": {
"type": "string"
},
"explicit_content_filter": {
"type": "integer"
},
"features": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"primary_category_id": {
"type": "string"
},
"icon": {
"type": "string"
},
"large": {
"type": "boolean",
"default": false
},
"max_members": {
"type": "integer"
},
"max_presences": {
"type": "integer"
},
"max_video_channel_users": {
"type": "integer"
},
"member_count": {
"type": "integer"
},
"presence_count": {
"type": "integer"
},
"members": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Member"
}
},
"roles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Role"
}
},
"channels": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Channel"
}
},
"template_id": {
"type": "string"
},
"template": {
"$ref": "#/components/schemas/Template"
},
"emojis": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Emoji"
}
},
"stickers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Sticker"
}
},
"invites": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Invite"
}
},
"voice_states": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VoiceState"
}
},
"webhooks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Webhook"
}
},
"mfa_level": {
"type": "integer"
},
"name": {
"type": "string"
},
"owner_id": {
"type": "string"
},
"owner": {
"$ref": "#/components/schemas/User"
},
"preferred_locale": {
"type": "string"
},
"premium_subscription_count": {
"type": "integer"
},
"premium_tier": {
"type": "integer"
},
"public_updates_channel_id": {
"type": "string"
},
"public_updates_channel": {
"$ref": "#/components/schemas/Channel"
},
"rules_channel_id": {
"type": "string"
},
"rules_channel": {
"type": "string"
},
"region": {
"type": "string"
},
"splash": {
"type": "string"
},
"system_channel_id": {
"type": "string"
},
"system_channel": {
"$ref": "#/components/schemas/Channel"
},
"system_channel_flags": {
"type": "integer"
},
"unavailable": {
"type": "boolean",
"default": false
},
"verification_level": {
"type": "integer"
},
"welcome_screen": {
"$ref": "#/components/schemas/GuildWelcomeScreen"
},
"widget_channel_id": {
"type": "string"
},
"widget_channel": {
"$ref": "#/components/schemas/Channel"
},
"widget_enabled": {
"type": "boolean",
"default": true
},
"nsfw_level": {
"type": "integer"
},
"nsfw": {
"type": "boolean",
"default": false
},
"parent": {
"type": "string"
},
"permissions": {
"type": "integer"
},
"premium_progress_bar_enabled": {
"type": "boolean",
"default": false
},
"id": {
"type": "string"
}
},
"required": [
"bans",
"channels",
"emojis",
"features",
"id",
"invites",
"joined_at",
"members",
"name",
"nsfw",
"premium_progress_bar_enabled",
"public_updates_channel_id",
"roles",
"stickers",
"template",
"unavailable",
"voice_states",
"webhooks",
"welcome_screen",
"widget_enabled"
]
},
"APIRoleArray": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Role"
}
},
"APIStickerArray": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Sticker"
}
},
"APITemplateArray": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Template"
}
},
"APIGuildVoiceRegion": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GuildVoiceRegion"
}
},
"APILimitsConfiguration": {
"type": "object",
"properties": {
"user": {
"$ref": "#/components/schemas/UserLimits"
},
"guild": {
"$ref": "#/components/schemas/GuildLimits"
},
"message": {
"$ref": "#/components/schemas/MessageLimits"
},
"channel": {
"$ref": "#/components/schemas/ChannelLimits"
},
"rate": {
"$ref": "#/components/schemas/RateLimits"
},
"absoluteRate": {
"$ref": "#/components/schemas/GlobalRateLimits"
}
},
"required": [
"absoluteRate",
"channel",
"guild",
"message",
"rate",
"user"
]
},
"APIStickerPackArray": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StickerPack"
}
},
"UpdatesResponse": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"pub_date": {
"type": "string"
},
"url": {
"type": "string"
},
"notes": {
"type": "string",
"nullable": true
}
},
"required": [
"name",
"notes",
"pub_date",
"url"
]
},
"UserNoteResponse": {
"type": "object",
"properties": {
"note": {
"type": "string"
},
"note_user_id": {
"type": "string"
},
"user_id": {
"type": "string"
}
},
"required": [
"note",
"note_user_id",
"user_id"
]
},
"UserProfileResponse": {
"type": "object",
"properties": {
"user": {
"$ref": "#/components/schemas/PublicUser"
},
"connected_accounts": {
"$ref": "#/components/schemas/PublicConnectedAccount"
},
"premium_guild_since": {
"type": "string",
"format": "date-time"
},
"premium_since": {
"type": "string",
"format": "date-time"
}
},
"required": [
"connected_accounts",
"user"
]
},
"UserRelationshipsResponse": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/RelationshipType"
},
"nickname": {
"type": "null"
},
"user": {
"$ref": "#/components/schemas/PublicUser"
}
},
"required": [
"id",
"nickname",
"type",
"user"
]
},
"UserRelationsResponse": {
"type": "object",
"properties": {
"object": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"username": {
"type": "string"
},
"avatar": {
"type": "string"
},
"discriminator": {
"type": "string"
},
"public_flags": {
"type": "integer"
}
},
"additionalProperties": false
}
},
"required": [
"object"
]
},
"WebAuthnCreateResponse": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"id": {
"type": "string"
}
},
"required": [
"id",
"name"
]
},
"WebhookCreateResponse": {
"type": "object",
"properties": {
"user": {
"$ref": "#/components/schemas/User"
},
"hook": {
"$ref": "#/components/schemas/Webhook"
}
},
"required": [
"hook",
"user"
]
},
"BulkDeleteSchema": {
"type": "object",
"properties": {
"messages": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"messages"
]
},
"LoginResponse": {
"anyOf": [
{
"$ref": "#/components/schemas/TokenResponse"
},
{
"$ref": "#/components/schemas/MFAResponse"
},
{
"$ref": "#/components/schemas/WebAuthnResponse"
}
]
},
"MemberNickChangeSchema": {
"type": "object",
"properties": {
"nick": {
"type": "string"
}
},
"required": [
"nick"
]
},
"PruneSchema": {
"type": "object",
"properties": {
"days": {
"type": "integer"
}
},
"required": [
"days"
]
},
"VerifyEmailSchema": {
"type": "object",
"properties": {
"captcha_key": {
"type": "string",
"nullable": true
},
"token": {
"type": "string"
}
},
"required": [
"token"
]
}
}
},
"tags": [
{
"name": "-"
},
{
"name": "applications"
},
{
"name": "auth"
},
{
"name": "channels"
},
{
"name": "connections"
},
{
"name": "discoverable-guilds"
},
{
"name": "discovery"
},
{
"name": "download"
},
{
"name": "experiments"
},
{
"name": "gateway"
},
{
"name": "gifs"
},
{
"name": "guild-recommendations"
},
{
"name": "guilds"
},
{
"name": "invites"
},
{
"name": "oauth2"
},
{
"name": "outbound-promotions"
},
{
"name": "partners"
},
{
"name": "ping"
},
{
"name": "policies"
},
{
"name": "read-states"
},
{
"name": "scheduled-maintenances"
},
{
"name": "science"
},
{
"name": "stage-instances"
},
{
"name": "sticker-packs"
},
{
"name": "stickers"
},
{
"name": "stop"
},
{
"name": "store"
},
{
"name": "teams"
},
{
"name": "track"
},
{
"name": "updates"
},
{
"name": "users"
},
{
"name": "voice"
}
],
"paths": {
"/voice/regions/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIGuildVoiceRegion"
}
}
}
}
},
"tags": [
"voice"
]
}
},
"/users/@me/settings/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserSettings"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"tags": [
"users"
]
},
"patch": {
"security": [
{
"bearer": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserSettingsSchema"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserSettings"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"tags": [
"users"
]
}
},
"/users/@me/relationships/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserRelationshipsResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"tags": [
"users"
]
},
"post": {
"security": [
{
"bearer": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RelationshipPostSchema"
}
}
}
},
"responses": {
"204": {
"description": "No description available"
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"tags": [
"users"
]
}
},
"/users/@me/relationships/{id}": {
"put": {
"security": [
{
"bearer": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RelationshipPutSchema"
}
}
}
},
"responses": {
"204": {
"description": "No description available"
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "id"
}
],
"tags": [
"users"
]
},
"delete": {
"security": [
{
"bearer": []
}
],
"responses": {
"204": {
"description": "No description available"
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "id"
}
],
"tags": [
"users"
]
}
},
"/users/@me/notes/{id}": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserNoteResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "id"
}
],
"tags": [
"users"
]
},
"put": {
"security": [
{
"bearer": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserNoteUpdateSchema"
}
}
}
},
"responses": {
"204": {
"description": "No description available"
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "id"
}
],
"tags": [
"users"
]
}
},
"/users/@me/mfa/webauthn/credentials/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"default": {
"description": "No description available"
}
},
"tags": [
"users"
]
},
"post": {
"security": [
{
"bearer": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebAuthnPostSchema"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebAuthnCreateResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"tags": [
"users"
]
}
},
"/users/@me/mfa/webauthn/credentials/{key_id}/": {
"delete": {
"security": [
{
"bearer": []
}
],
"responses": {
"204": {
"description": "No description available"
}
},
"parameters": [
{
"name": "key_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "key_id"
}
],
"tags": [
"users"
]
}
},
"/users/@me/mfa/totp/enable/": {
"post": {
"security": [
{
"bearer": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TotpEnableSchema"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TokenWithBackupCodesResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"tags": [
"users"
]
}
},
"/users/@me/mfa/totp/disable/": {
"post": {
"security": [
{
"bearer": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TotpDisableSchema"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TokenOnlyResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"tags": [
"users"
]
}
},
"/users/@me/mfa/codes/": {
"post": {
"security": [
{
"bearer": []
}
],
"description": "This route is replaced with users/@me/mfa/codes-verification in newer clients",
"deprecated": true,
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MfaCodesSchema"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIBackupCodeArray"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"tags": [
"users"
]
}
},
"/users/@me/mfa/codes-verification/": {
"post": {
"security": [
{
"bearer": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CodesVerificationSchema"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIBackupCodeArray"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"tags": [
"users"
]
}
},
"/users/@me/library/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"default": {
"description": "No description available"
}
},
"tags": [
"users"
]
}
},
"/users/@me/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIPrivateUser"
}
}
}
}
},
"tags": [
"users"
]
},
"patch": {
"security": [
{
"bearer": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserModifySchema"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserUpdateResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"tags": [
"users"
]
}
},
"/users/@me/guilds/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIGuildArray"
}
}
}
}
},
"tags": [
"users"
]
}
},
"/users/@me/guilds/{guild_id}": {
"delete": {
"security": [
{
"bearer": []
}
],
"responses": {
"204": {
"description": "No description available"
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "guild_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "guild_id"
}
],
"tags": [
"users"
]
}
},
"/users/@me/guilds/premium/subscription-slots/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"default": {
"description": "No description available"
}
},
"tags": [
"users"
]
}
},
"/users/@me/guilds/{guild_id}/settings/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"200": {
"description": "No description available"
},
"404": {
"description": "No description available"
}
},
"parameters": [
{
"name": "guild_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "guild_id"
}
],
"tags": [
"users"
]
},
"patch": {
"security": [
{
"bearer": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserGuildSettingsSchema"
}
}
}
},
"responses": {
"200": {
"description": "No description available"
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "guild_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "guild_id"
}
],
"tags": [
"users"
]
}
},
"/users/@me/entitlements/gifts": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"default": {
"description": "No description available"
}
},
"tags": [
"users"
]
}
},
"/users/@me/email-settings/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"default": {
"description": "No description available"
}
},
"tags": [
"users"
]
}
},
"/users/@me/disable/": {
"post": {
"security": [
{
"bearer": []
}
],
"responses": {
"204": {
"description": "No description available"
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"tags": [
"users"
]
}
},
"/users/@me/devices/": {
"post": {
"security": [
{
"bearer": []
}
],
"responses": {
"default": {
"description": "No description available"
}
},
"tags": [
"users"
]
}
},
"/users/@me/delete/": {
"post": {
"security": [
{
"bearer": []
}
],
"responses": {
"204": {
"description": "No description available"
},
"401": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"tags": [
"users"
]
}
},
"/users/@me/connections/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"default": {
"description": "No description available"
}
},
"tags": [
"users"
]
}
},
"/users/@me/connections/{connection_name}/{connection_id}/": {
"patch": {
"security": [
{
"bearer": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectionUpdateSchema"
}
}
}
},
"responses": {
"default": {
"description": "No description available"
}
},
"parameters": [
{
"name": "connection_name",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "connection_name"
},
{
"name": "connection_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "connection_id"
}
],
"tags": [
"users"
]
},
"delete": {
"security": [
{
"bearer": []
}
],
"responses": {
"default": {
"description": "No description available"
}
},
"parameters": [
{
"name": "connection_name",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "connection_name"
},
{
"name": "connection_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "connection_id"
}
],
"tags": [
"users"
]
}
},
"/users/@me/connections/{connection_name}/{connection_id}/access-token/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"default": {
"description": "No description available"
}
},
"parameters": [
{
"name": "connection_name",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "connection_name"
},
{
"name": "connection_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "connection_id"
}
],
"tags": [
"users"
]
}
},
"/users/@me/channels/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIDMChannelArray"
}
}
}
}
},
"tags": [
"users"
]
},
"post": {
"security": [
{
"bearer": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DmChannelCreateSchema"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DmChannelDTO"
}
}
}
}
},
"tags": [
"users"
]
}
},
"/users/@me/billing/subscriptions/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"default": {
"description": "No description available"
}
},
"tags": [
"users"
]
}
},
"/users/@me/billing/payment-sources/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"default": {
"description": "No description available"
}
},
"tags": [
"users"
]
}
},
"/users/@me/billing/country-code/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"default": {
"description": "No description available"
}
},
"tags": [
"users"
]
}
},
"/users/@me/applications/{app_id}/entitlements/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"default": {
"description": "No description available"
}
},
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "app_id"
}
],
"tags": [
"users"
]
}
},
"/users/@me/affinities/users/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"default": {
"description": "No description available"
}
},
"tags": [
"users"
]
}
},
"/users/@me/affinities/guilds/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"default": {
"description": "No description available"
}
},
"tags": [
"users"
]
}
},
"/users/@me/activities/statistics/applications/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"default": {
"description": "No description available"
}
},
"tags": [
"users"
]
}
},
"/users/{id}/relationships/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserRelationsResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "id"
}
],
"tags": [
"users"
]
}
},
"/users/{id}/profile/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserProfileResponse"
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "id"
}
],
"tags": [
"users"
]
},
"patch": {
"security": [
{
"bearer": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserProfileModifySchema"
}
}
}
},
"responses": {
"default": {
"description": "No description available"
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "id"
}
],
"tags": [
"users"
]
}
},
"/users/{id}/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIPublicUser"
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "id"
}
],
"tags": [
"users"
]
}
},
"/users/{id}/delete/": {
"post": {
"x-right-required": "MANAGE_USERS",
"security": [
{
"bearer": []
}
],
"responses": {
"204": {
"description": "No description available"
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "id"
}
],
"tags": [
"users"
]
}
},
"/updates/": {
"get": {
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdatesResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"tags": [
"updates"
]
}
},
"/track/": {
"post": {
"responses": {
"default": {
"description": "No description available"
}
},
"tags": [
"track"
]
}
},
"/teams/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"default": {
"description": "No description available"
}
},
"tags": [
"teams"
]
}
},
"/store/published-listings/skus/{id}": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"default": {
"description": "No description available"
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "id"
}
],
"tags": [
"store"
]
}
},
"/store/published-listings/skus/{sku_id}/subscription-plans/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"default": {
"description": "No description available"
}
},
"parameters": [
{
"name": "sku_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "sku_id"
}
],
"tags": [
"store"
]
}
},
"/store/published-listings/applications/{id}": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"default": {
"description": "No description available"
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "id"
}
],
"tags": [
"store"
]
}
},
"/store/published-listings/applications/{id}/subscription-plans/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"default": {
"description": "No description available"
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "id"
}
],
"tags": [
"store"
]
}
},
"/stop/": {
"post": {
"x-right-required": "OPERATOR",
"security": [
{
"bearer": []
}
],
"responses": {
"200": {
"description": "No description available"
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"tags": [
"stop"
]
}
},
"/stickers/{sticker_id}/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Sticker"
}
}
}
}
},
"parameters": [
{
"name": "sticker_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "sticker_id"
}
],
"tags": [
"stickers"
]
}
},
"/sticker-packs/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIStickerPackArray"
}
}
}
}
},
"tags": [
"sticker-packs"
]
}
},
"/stage-instances/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"default": {
"description": "No description available"
}
},
"tags": [
"stage-instances"
]
}
},
"/science/": {
"post": {
"responses": {
"204": {
"description": "No description available"
}
},
"tags": [
"science"
]
}
},
"/scheduled-maintenances/upcoming_json/scheduled-maintenances/upcoming.json": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"default": {
"description": "No description available"
}
},
"tags": [
"scheduled-maintenances"
]
}
},
"/read-states/ack-bulk/": {
"post": {
"security": [
{
"bearer": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AckBulkSchema"
}
}
}
},
"responses": {
"204": {
"description": "No description available"
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"tags": [
"read-states"
]
}
},
"/policies/stats/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InstanceStatsResponse"
}
}
}
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"tags": [
"policies"
]
}
},
"/policies/instance/limits/": {
"get": {
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APILimitsConfiguration"
}
}
}
}
},
"tags": [
"policies"
]
}
},
"/policies/instance/": {
"get": {
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIGeneralConfiguration"
}
}
}
}
},
"tags": [
"policies"
]
}
},
"/policies/instance/domains/": {
"get": {
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InstanceDomainsResponse"
}
}
}
}
},
"tags": [
"policies"
]
}
},
"/ping/": {
"get": {
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InstancePingResponse"
}
}
}
}
},
"tags": [
"ping"
]
}
},
"/partners/{guild_id}/requirements/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"default": {
"description": "No description available"
}
},
"parameters": [
{
"name": "guild_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "guild_id"
}
],
"tags": [
"partners"
]
}
},
"/outbound-promotions/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"default": {
"description": "No description available"
}
},
"tags": [
"outbound-promotions"
]
}
},
"/oauth2/tokens/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"default": {
"description": "No description available"
}
},
"tags": [
"oauth2"
]
}
},
"/oauth2/authorize/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"200": {
"description": "No description available"
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"tags": [
"oauth2"
]
},
"post": {
"security": [
{
"bearer": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApplicationAuthorizeSchema"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OAuthAuthorizeResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "client_id",
"in": "query",
"schema": {
"type": "string"
}
}
],
"tags": [
"oauth2"
]
}
},
"/invites/{code}": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Invite"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "code",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "code"
}
],
"tags": [
"invites"
]
},
"post": {
"x-right-required": "USE_MASS_INVITES",
"security": [
{
"bearer": []
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Invite"
}
}
}
},
"401": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "code",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "code"
}
],
"tags": [
"invites"
]
},
"delete": {
"security": [
{
"bearer": []
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Invite"
}
}
}
},
"401": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "code",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "code"
}
],
"tags": [
"invites"
]
}
},
"/guilds/templates/{code}": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Template"
}
}
}
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "code",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "code"
}
],
"tags": [
"guilds"
]
},
"post": {
"security": [
{
"bearer": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GuildTemplateCreateSchema"
}
}
}
},
"responses": {
"default": {
"description": "No description available"
}
},
"parameters": [
{
"name": "code",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "code"
}
],
"tags": [
"guilds"
]
}
},
"/guilds/": {
"post": {
"x-right-required": "CREATE_GUILDS",
"security": [
{
"bearer": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GuildCreateSchema"
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GuildCreateResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"tags": [
"guilds"
]
}
},
"/guilds/{guild_id}/widget.png/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"200": {
"description": "No description available"
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "guild_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "guild_id"
}
],
"tags": [
"guilds"
]
}
},
"/guilds/{guild_id}/widget.json/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GuildWidgetJsonResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "guild_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "guild_id"
}
],
"tags": [
"guilds"
]
}
},
"/guilds/{guild_id}/widget/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GuildWidgetSettingsResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "guild_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "guild_id"
}
],
"tags": [
"guilds"
]
},
"patch": {
"x-permission-required": "MANAGE_GUILD",
"security": [
{
"bearer": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WidgetModifySchema"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WidgetModifySchema"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "guild_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "guild_id"
}
],
"tags": [
"guilds"
]
}
},
"/guilds/{guild_id}/welcome-screen/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GuildWelcomeScreen"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "guild_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "guild_id"
}
],
"tags": [
"guilds"
]
},
"patch": {
"x-permission-required": "MANAGE_GUILD",
"security": [
{
"bearer": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GuildUpdateWelcomeScreenSchema"
}
}
}
},
"responses": {
"204": {
"description": "No description available"
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "guild_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "guild_id"
}
],
"tags": [
"guilds"
]
}
},
"/guilds/{guild_id}/webhooks/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"default": {
"description": "No description available"
}
},
"parameters": [
{
"name": "guild_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "guild_id"
}
],
"tags": [
"guilds"
]
}
},
"/guilds/{guild_id}/voice-states/{user_id}/": {
"patch": {
"security": [
{
"bearer": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VoiceStateUpdateSchema"
}
}
}
},
"responses": {
"204": {
"description": "No description available"
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "guild_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "guild_id"
},
{
"name": "user_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "user_id"
}
],
"tags": [
"guilds"
]
}
},
"/guilds/{guild_id}/vanity-url/": {
"get": {
"x-permission-required": "MANAGE_GUILD",
"security": [
{
"bearer": []
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GuildVanityUrlResponse"
}
}
}
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "guild_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "guild_id"
}
],
"tags": [
"guilds"
]
},
"patch": {
"x-permission-required": "MANAGE_GUILD",
"security": [
{
"bearer": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VanityUrlSchema"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GuildVanityUrlCreateResponse"
}
}
}
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "guild_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "guild_id"
}
],
"tags": [
"guilds"
]
}
},
"/guilds/{guild_id}/templates/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APITemplateArray"
}
}
}
}
},
"parameters": [
{
"name": "guild_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "guild_id"
}
],
"tags": [
"guilds"
]
},
"post": {
"x-permission-required": "MANAGE_GUILD",
"security": [
{
"bearer": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TemplateCreateSchema"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Template"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "guild_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "guild_id"
}
],
"tags": [
"guilds"
]
}
},
"/guilds/{guild_id}/templates/{code}": {
"delete": {
"x-permission-required": "MANAGE_GUILD",
"security": [
{
"bearer": []
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Template"
}
}
}
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "guild_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "guild_id"
},
{
"name": "code",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "code"
}
],
"tags": [
"guilds"
]
},
"put": {
"x-permission-required": "MANAGE_GUILD",
"security": [
{
"bearer": []
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Template"
}
}
}
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "guild_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "guild_id"
},
{
"name": "code",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "code"
}
],
"tags": [
"guilds"
]
},
"patch": {
"x-permission-required": "MANAGE_GUILD",
"security": [
{
"bearer": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TemplateModifySchema"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Template"
}
}
}
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "guild_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "guild_id"
},
{
"name": "code",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "code"
}
],
"tags": [
"guilds"
]
}
},
"/guilds/{guild_id}/stickers/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIStickerArray"
}
}
}
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "guild_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "guild_id"
}
],
"tags": [
"guilds"
]
},
"post": {
"x-permission-required": "MANAGE_EMOJIS_AND_STICKERS",
"security": [
{
"bearer": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModifyGuildStickerSchema"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Sticker"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "guild_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "guild_id"
}
],
"tags": [
"guilds"
]
}
},
"/guilds/{guild_id}/stickers/{sticker_id}": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Sticker"
}
}
}
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "guild_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "guild_id"
},
{
"name": "sticker_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "sticker_id"
}
],
"tags": [
"guilds"
]
},
"patch": {
"x-permission-required": "MANAGE_EMOJIS_AND_STICKERS",
"security": [
{
"bearer": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModifyGuildStickerSchema"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Sticker"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "guild_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "guild_id"
},
{
"name": "sticker_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "sticker_id"
}
],
"tags": [
"guilds"
]
},
"delete": {
"x-permission-required": "MANAGE_EMOJIS_AND_STICKERS",
"security": [
{
"bearer": []
}
],
"responses": {
"204": {
"description": "No description available"
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "guild_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "guild_id"
},
{
"name": "sticker_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "sticker_id"
}
],
"tags": [
"guilds"
]
}
},
"/guilds/{guild_id}/roles/member-counts/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"default": {
"description": "No description available"
}
},
"parameters": [
{
"name": "guild_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "guild_id"
}
],
"tags": [
"guilds"
]
}
},
"/guilds/{guild_id}/roles/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"default": {
"description": "No description available"
}
},
"parameters": [
{
"name": "guild_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "guild_id"
}
],
"tags": [
"guilds"
]
},
"post": {
"x-permission-required": "MANAGE_ROLES",
"security": [
{
"bearer": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RoleModifySchema"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Role"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "guild_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "guild_id"
}
],
"tags": [
"guilds"
]
},
"patch": {
"x-permission-required": "MANAGE_ROLES",
"security": [
{
"bearer": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RolePositionUpdateSchema"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIRoleArray"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "guild_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "guild_id"
}
],
"tags": [
"guilds"
]
}
},
"/guilds/{guild_id}/roles/{role_id}/members/": {
"patch": {
"x-permission-required": "MANAGE_ROLES",
"security": [
{
"bearer": []
}
],
"responses": {
"default": {
"description": "No description available"
}
},
"parameters": [
{
"name": "guild_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "guild_id"
},
{
"name": "role_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "role_id"
}
],
"tags": [
"guilds"
]
}
},
"/guilds/{guild_id}/roles/{role_id}/member-ids/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"default": {
"description": "No description available"
}
},
"parameters": [
{
"name": "guild_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "guild_id"
},
{
"name": "role_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "role_id"
}
],
"tags": [
"guilds"
]
}
},
"/guilds/{guild_id}/roles/{role_id}/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Role"
}
}
}
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "guild_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "guild_id"
},
{
"name": "role_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "role_id"
}
],
"tags": [
"guilds"
]
},
"delete": {
"x-permission-required": "MANAGE_ROLES",
"security": [
{
"bearer": []
}
],
"responses": {
"204": {
"description": "No description available"
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "guild_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "guild_id"
},
{
"name": "role_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "role_id"
}
],
"tags": [
"guilds"
]
},
"patch": {
"x-permission-required": "MANAGE_ROLES",
"security": [
{
"bearer": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RoleModifySchema"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Role"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "guild_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "guild_id"
},
{
"name": "role_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "role_id"
}
],
"tags": [
"guilds"
]
}
},
"/guilds/{guild_id}/regions/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIGuildVoiceRegion"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "guild_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "guild_id"
}
],
"tags": [
"guilds"
]
}
},
"/guilds/{guild_id}/prune/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GuildPruneResponse"
}
}
}
}
},
"parameters": [
{
"name": "guild_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "guild_id"
}
],
"tags": [
"guilds"
]
},
"post": {
"x-right-required": "KICK_BAN_MEMBERS",
"x-permission-required": "KICK_MEMBERS",
"security": [
{
"bearer": []
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GuildPurgeResponse"
}
}
}
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "guild_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "guild_id"
}
],
"tags": [
"guilds"
]
}
},
"/guilds/{guild_id}/profile/{member_id}": {
"patch": {
"security": [
{
"bearer": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MemberChangeProfileSchema"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Member"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "guild_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "guild_id"
},
{
"name": "member_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "member_id"
}
],
"tags": [
"guilds"
]
}
},
"/guilds/{guild_id}/premium/subscriptions": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"default": {
"description": "No description available"
}
},
"parameters": [
{
"name": "guild_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "guild_id"
}
],
"tags": [
"guilds"
]
}
},
"/guilds/{guild_id}/messages/search/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GuildMessagesSearchResponse"
}
}
}
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"422": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "guild_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "guild_id"
}
],
"tags": [
"guilds"
]
}
},
"/guilds/{guild_id}/members/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIMemberArray"
}
}
}
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "guild_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "guild_id"
},
{
"name": "limit",
"in": "query",
"schema": {
"type": "number"
},
"description": "max number of members to return (1-1000). default 1"
},
{
"name": "after",
"in": "query",
"schema": {
"type": "string"
}
}
],
"tags": [
"guilds"
]
}
},
"/guilds/{guild_id}/members/{member_id}/roles/{role_id}/": {
"delete": {
"x-permission-required": "MANAGE_ROLES",
"security": [
{
"bearer": []
}
],
"responses": {
"204": {
"description": "No description available"
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "guild_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "guild_id"
},
{
"name": "member_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "member_id"
},
{
"name": "role_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "role_id"
}
],
"tags": [
"guilds"
]
},
"put": {
"x-permission-required": "MANAGE_ROLES",
"security": [
{
"bearer": []
}
],
"responses": {
"204": {
"description": "No description available"
},
"403": {
"description": "No description available"
}
},
"parameters": [
{
"name": "guild_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "guild_id"
},
{
"name": "member_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "member_id"
},
{
"name": "role_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "role_id"
}
],
"tags": [
"guilds"
]
}
},
"/guilds/{guild_id}/members/{member_id}/nick/": {
"patch": {
"security": [
{
"bearer": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MemberNickChangeSchema"
}
}
}
},
"responses": {
"200": {
"description": "No description available"
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "guild_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "guild_id"
},
{
"name": "member_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "member_id"
}
],
"tags": [
"guilds"
]
}
},
"/guilds/{guild_id}/members/{member_id}/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Member"
}
}
}
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "guild_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "guild_id"
},
{
"name": "member_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "member_id"
}
],
"tags": [
"guilds"
]
},
"patch": {
"security": [
{
"bearer": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MemberChangeSchema"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Member"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "guild_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "guild_id"
},
{
"name": "member_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "member_id"
}
],
"tags": [
"guilds"
]
},
"put": {
"security": [
{
"bearer": []
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MemberJoinGuildResponse"
}
}
}
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "guild_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "guild_id"
},
{
"name": "member_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "member_id"
}
],
"tags": [
"guilds"
]
},
"delete": {
"security": [
{
"bearer": []
}
],
"responses": {
"204": {
"description": "No description available"
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "guild_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "guild_id"
},
{
"name": "member_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "member_id"
}
],
"tags": [
"guilds"
]
}
},
"/guilds/{guild_id}/member-verification/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "guild_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "guild_id"
}
],
"tags": [
"guilds"
]
}
},
"/guilds/{guild_id}/invites/": {
"get": {
"x-permission-required": "MANAGE_GUILD",
"security": [
{
"bearer": []
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIInviteArray"
}
}
}
}
},
"parameters": [
{
"name": "guild_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "guild_id"
}
],
"tags": [
"guilds"
]
}
},
"/guilds/{guild_id}/integrations/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"default": {
"description": "No description available"
}
},
"parameters": [
{
"name": "guild_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "guild_id"
}
],
"tags": [
"guilds"
]
}
},
"/guilds/{guild_id}/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIGuildWithJoinedAt"
}
}
}
},
"401": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "guild_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "guild_id"
}
],
"tags": [
"guilds"
]
},
"patch": {
"x-permission-required": "MANAGE_GUILD",
"security": [
{
"bearer": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GuildUpdateSchema"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GuildUpdateSchema"
}
}
}
},
"401": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "guild_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "guild_id"
}
],
"tags": [
"guilds"
]
}
},
"/guilds/{guild_id}/emojis/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIEmojiArray"
}
}
}
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "guild_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "guild_id"
}
],
"tags": [
"guilds"
]
},
"post": {
"x-permission-required": "MANAGE_EMOJIS_AND_STICKERS",
"security": [
{
"bearer": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmojiCreateSchema"
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Emoji"
}
}
}
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "guild_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "guild_id"
}
],
"tags": [
"guilds"
]
}
},
"/guilds/{guild_id}/emojis/{emoji_id}": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Emoji"
}
}
}
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "guild_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "guild_id"
},
{
"name": "emoji_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "emoji_id"
}
],
"tags": [
"guilds"
]
},
"patch": {
"x-permission-required": "MANAGE_EMOJIS_AND_STICKERS",
"security": [
{
"bearer": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmojiModifySchema"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Emoji"
}
}
}
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "guild_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "guild_id"
},
{
"name": "emoji_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "emoji_id"
}
],
"tags": [
"guilds"
]
},
"delete": {
"x-permission-required": "MANAGE_EMOJIS_AND_STICKERS",
"security": [
{
"bearer": []
}
],
"responses": {
"204": {
"description": "No description available"
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "guild_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "guild_id"
},
{
"name": "emoji_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "emoji_id"
}
],
"tags": [
"guilds"
]
}
},
"/guilds/{guild_id}/discovery-requirements/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GuildDiscoveryRequirementsResponse"
}
}
}
}
},
"parameters": [
{
"name": "guild_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "guild_id"
}
],
"tags": [
"guilds"
]
}
},
"/guilds/{guild_id}/delete/": {
"post": {
"security": [
{
"bearer": []
}
],
"responses": {
"204": {
"description": "No description available"
},
"401": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "guild_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "guild_id"
}
],
"tags": [
"guilds"
]
}
},
"/guilds/{guild_id}/channels/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIChannelArray"
}
}
}
}
},
"parameters": [
{
"name": "guild_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "guild_id"
}
],
"tags": [
"guilds"
]
},
"post": {
"x-permission-required": "MANAGE_CHANNELS",
"security": [
{
"bearer": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChannelModifySchema"
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Channel"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "guild_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "guild_id"
}
],
"tags": [
"guilds"
]
},
"patch": {
"x-permission-required": "MANAGE_CHANNELS",
"security": [
{
"bearer": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChannelReorderSchema"
}
}
}
},
"responses": {
"204": {
"description": "No description available"
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "guild_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "guild_id"
}
],
"tags": [
"guilds"
]
}
},
"/guilds/{guild_id}/bans/": {
"get": {
"x-permission-required": "BAN_MEMBERS",
"security": [
{
"bearer": []
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GuildBansResponse"
}
}
}
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "guild_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "guild_id"
}
],
"tags": [
"guilds"
]
}
},
"/guilds/{guild_id}/bans/{user}": {
"get": {
"x-permission-required": "BAN_MEMBERS",
"security": [
{
"bearer": []
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BanModeratorSchema"
}
}
}
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "guild_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "guild_id"
},
{
"name": "user",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "user"
}
],
"tags": [
"guilds"
]
}
},
"/guilds/{guild_id}/bans/{user_id}": {
"put": {
"x-permission-required": "BAN_MEMBERS",
"security": [
{
"bearer": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BanCreateSchema"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Ban"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "guild_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "guild_id"
},
{
"name": "user_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "user_id"
}
],
"tags": [
"guilds"
]
},
"delete": {
"x-permission-required": "BAN_MEMBERS",
"security": [
{
"bearer": []
}
],
"responses": {
"204": {
"description": "No description available"
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "guild_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "guild_id"
},
{
"name": "user_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "user_id"
}
],
"tags": [
"guilds"
]
}
},
"/guilds/{guild_id}/bans/@me": {
"put": {
"security": [
{
"bearer": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BanCreateSchema"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Ban"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "guild_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "guild_id"
}
],
"tags": [
"guilds"
]
}
},
"/guilds/{guild_id}/audit-logs/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"default": {
"description": "No description available"
}
},
"parameters": [
{
"name": "guild_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "guild_id"
}
],
"tags": [
"guilds"
]
}
},
"/guild-recommendations/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GuildRecommendationsResponse"
}
}
}
}
},
"tags": [
"guild-recommendations"
]
}
},
"/gifs/trending/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TenorTrendingResponse"
}
}
}
}
},
"parameters": [
{
"name": "locale",
"in": "query",
"schema": {
"type": "string"
},
"description": "Locale"
}
],
"tags": [
"gifs"
]
}
},
"/gifs/trending-gifs/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TenorGifsResponse"
}
}
}
}
},
"parameters": [
{
"name": "media_format",
"in": "query",
"schema": {
"type": "string"
},
"description": "Media format"
},
{
"name": "locale",
"in": "query",
"schema": {
"type": "string"
},
"description": "Locale"
}
],
"tags": [
"gifs"
]
}
},
"/gifs/search/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TenorGifsResponse"
}
}
}
}
},
"parameters": [
{
"name": "q",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "Search query"
},
{
"name": "media_format",
"in": "query",
"schema": {
"type": "string"
},
"description": "Media format"
},
{
"name": "locale",
"in": "query",
"schema": {
"type": "string"
},
"description": "Locale"
}
],
"tags": [
"gifs"
]
}
},
"/gateway/": {
"get": {
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GatewayResponse"
}
}
}
}
},
"tags": [
"gateway"
]
}
},
"/gateway/bot/": {
"get": {
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GatewayBotResponse"
}
}
}
}
},
"tags": [
"gateway"
]
}
},
"/experiments/": {
"get": {
"responses": {
"default": {
"description": "No description available"
}
},
"tags": [
"experiments"
]
}
},
"/download/": {
"get": {
"responses": {
"302": {
"description": "No description available"
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"tags": [
"download"
]
}
},
"/discovery/categories": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIDiscoveryCategoryArray"
}
}
}
}
},
"tags": [
"discovery"
]
}
},
"/discoverable-guilds/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DiscoverableGuildsResponse"
}
}
}
}
},
"tags": [
"discoverable-guilds"
]
}
},
"/connections/{connection_name}/callback/": {
"post": {
"security": [
{
"bearer": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectionCallbackSchema"
}
}
}
},
"responses": {
"default": {
"description": "No description available"
}
},
"parameters": [
{
"name": "connection_name",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "connection_name"
}
],
"tags": [
"connections"
]
}
},
"/connections/{connection_name}/authorize/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"default": {
"description": "No description available"
}
},
"parameters": [
{
"name": "connection_name",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "connection_name"
}
],
"tags": [
"connections"
]
}
},
"/connections/{connection_name}/{connection_id}/refresh/": {
"post": {
"security": [
{
"bearer": []
}
],
"responses": {
"default": {
"description": "No description available"
}
},
"parameters": [
{
"name": "connection_name",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "connection_name"
},
{
"name": "connection_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "connection_id"
}
],
"tags": [
"connections"
]
}
},
"/channels/{channel_id}/webhooks/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIWebhookArray"
}
}
}
}
},
"parameters": [
{
"name": "channel_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "channel_id"
}
],
"tags": [
"channels"
]
},
"post": {
"x-permission-required": "MANAGE_WEBHOOKS",
"security": [
{
"bearer": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebhookCreateSchema"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebhookCreateResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"403": {
"description": "No description available"
}
},
"parameters": [
{
"name": "channel_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "channel_id"
}
],
"tags": [
"channels"
]
}
},
"/channels/{channel_id}/typing/": {
"post": {
"x-permission-required": "SEND_MESSAGES",
"security": [
{
"bearer": []
}
],
"responses": {
"204": {
"description": "No description available"
},
"403": {
"description": "No description available"
},
"404": {
"description": "No description available"
}
},
"parameters": [
{
"name": "channel_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "channel_id"
}
],
"tags": [
"channels"
]
}
},
"/channels/{channel_id}/recipients/{user_id}": {
"put": {
"security": [
{
"bearer": []
}
],
"responses": {
"201": {
"description": "No description available"
},
"404": {
"description": "No description available"
}
},
"parameters": [
{
"name": "channel_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "channel_id"
},
{
"name": "user_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "user_id"
}
],
"tags": [
"channels"
]
},
"delete": {
"security": [
{
"bearer": []
}
],
"responses": {
"204": {
"description": "No description available"
},
"404": {
"description": "No description available"
}
},
"parameters": [
{
"name": "channel_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "channel_id"
},
{
"name": "user_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "user_id"
}
],
"tags": [
"channels"
]
}
},
"/channels/{channel_id}/purge/": {
"post": {
"security": [
{
"bearer": []
}
],
"responses": {
"204": {
"description": "No description available"
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"403": {
"description": "No description available"
},
"404": {
"description": "No description available"
}
},
"parameters": [
{
"name": "channel_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "channel_id"
}
],
"tags": [
"channels"
]
}
},
"/channels/{channel_id}/pins/{message_id}": {
"put": {
"x-permission-required": "VIEW_CHANNEL",
"security": [
{
"bearer": []
}
],
"responses": {
"204": {
"description": "No description available"
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"403": {
"description": "No description available"
},
"404": {
"description": "No description available"
}
},
"parameters": [
{
"name": "channel_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "channel_id"
},
{
"name": "message_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "message_id"
}
],
"tags": [
"channels"
]
},
"delete": {
"x-permission-required": "VIEW_CHANNEL",
"security": [
{
"bearer": []
}
],
"responses": {
"204": {
"description": "No description available"
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"403": {
"description": "No description available"
},
"404": {
"description": "No description available"
}
},
"parameters": [
{
"name": "channel_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "channel_id"
},
{
"name": "message_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "message_id"
}
],
"tags": [
"channels"
]
}
},
"/channels/{channel_id}/pins/": {
"get": {
"x-permission-required": [
"READ_MESSAGE_HISTORY"
],
"security": [
{
"bearer": []
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIMessageArray"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "channel_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "channel_id"
}
],
"tags": [
"channels"
]
}
},
"/channels/{channel_id}/permissions/{overwrite_id}": {
"put": {
"x-permission-required": "MANAGE_ROLES",
"security": [
{
"bearer": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChannelPermissionOverwriteSchema"
}
}
}
},
"responses": {
"204": {
"description": "No description available"
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"404": {
"description": "No description available"
},
"501": {
"description": "No description available"
}
},
"parameters": [
{
"name": "channel_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "channel_id"
},
{
"name": "overwrite_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "overwrite_id"
}
],
"tags": [
"channels"
]
},
"delete": {
"x-permission-required": "MANAGE_ROLES",
"security": [
{
"bearer": []
}
],
"responses": {
"204": {
"description": "No description available"
},
"404": {
"description": "No description available"
}
},
"parameters": [
{
"name": "channel_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "channel_id"
},
{
"name": "overwrite_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "overwrite_id"
}
],
"tags": [
"channels"
]
}
},
"/channels/{channel_id}/messages/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIMessageArray"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"403": {
"description": "No description available"
},
"404": {
"description": "No description available"
}
},
"parameters": [
{
"name": "channel_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "channel_id"
},
{
"name": "around",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "before",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "after",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"schema": {
"type": "number"
},
"description": "max number of messages to return (1-100). defaults to 50"
}
],
"tags": [
"channels"
]
},
"post": {
"x-right-required": "SEND_MESSAGES",
"x-permission-required": "SEND_MESSAGES",
"security": [
{
"bearer": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MessageCreateSchema"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"403": {
"description": "No description available"
},
"404": {
"description": "No description available"
}
},
"parameters": [
{
"name": "channel_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "channel_id"
}
],
"tags": [
"channels"
]
}
},
"/channels/{channel_id}/messages/bulk-delete/": {
"post": {
"security": [
{
"bearer": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BulkDeleteSchema"
}
}
}
},
"responses": {
"204": {
"description": "No description available"
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"403": {
"description": "No description available"
},
"404": {
"description": "No description available"
}
},
"parameters": [
{
"name": "channel_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "channel_id"
}
],
"tags": [
"channels"
]
}
},
"/channels/{channel_id}/messages/{message_id}/reactions/": {
"delete": {
"x-permission-required": "MANAGE_MESSAGES",
"security": [
{
"bearer": []
}
],
"responses": {
"204": {
"description": "No description available"
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"403": {
"description": "No description available"
},
"404": {
"description": "No description available"
}
},
"parameters": [
{
"name": "channel_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "channel_id"
},
{
"name": "message_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "message_id"
}
],
"tags": [
"channels"
]
}
},
"/channels/{channel_id}/messages/{message_id}/reactions/{emoji}": {
"delete": {
"x-permission-required": "MANAGE_MESSAGES",
"security": [
{
"bearer": []
}
],
"responses": {
"204": {
"description": "No description available"
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"403": {
"description": "No description available"
},
"404": {
"description": "No description available"
}
},
"parameters": [
{
"name": "channel_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "channel_id"
},
{
"name": "message_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "message_id"
},
{
"name": "emoji",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "emoji"
}
],
"tags": [
"channels"
]
},
"get": {
"x-permission-required": "VIEW_CHANNEL",
"security": [
{
"bearer": []
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicUser"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"403": {
"description": "No description available"
},
"404": {
"description": "No description available"
}
},
"parameters": [
{
"name": "channel_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "channel_id"
},
{
"name": "message_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "message_id"
},
{
"name": "emoji",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "emoji"
}
],
"tags": [
"channels"
]
}
},
"/channels/{channel_id}/messages/{message_id}/reactions/{emoji}/{user_id}": {
"put": {
"x-right-required": "SELF_ADD_REACTIONS",
"x-permission-required": "READ_MESSAGE_HISTORY",
"security": [
{
"bearer": []
}
],
"responses": {
"204": {
"description": "No description available"
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"403": {
"description": "No description available"
},
"404": {
"description": "No description available"
}
},
"parameters": [
{
"name": "channel_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "channel_id"
},
{
"name": "message_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "message_id"
},
{
"name": "emoji",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "emoji"
},
{
"name": "user_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "user_id"
}
],
"tags": [
"channels"
]
},
"delete": {
"security": [
{
"bearer": []
}
],
"responses": {
"204": {
"description": "No description available"
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"403": {
"description": "No description available"
},
"404": {
"description": "No description available"
}
},
"parameters": [
{
"name": "channel_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "channel_id"
},
{
"name": "message_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "message_id"
},
{
"name": "emoji",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "emoji"
},
{
"name": "user_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "user_id"
}
],
"tags": [
"channels"
]
}
},
"/channels/{channel_id}/messages/{message_id}/": {
"patch": {
"x-right-required": "SEND_MESSAGES",
"x-permission-required": "SEND_MESSAGES",
"security": [
{
"bearer": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MessageEditSchema"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"403": {
"description": "No description available"
},
"404": {
"description": "No description available"
}
},
"parameters": [
{
"name": "channel_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "channel_id"
},
{
"name": "message_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "message_id"
}
],
"tags": [
"channels"
]
},
"put": {
"x-right-required": "SEND_BACKDATED_EVENTS",
"x-permission-required": "SEND_MESSAGES",
"security": [
{
"bearer": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MessageCreateSchema"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"403": {
"description": "No description available"
},
"404": {
"description": "No description available"
}
},
"parameters": [
{
"name": "channel_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "channel_id"
},
{
"name": "message_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "message_id"
}
],
"tags": [
"channels"
]
},
"get": {
"x-permission-required": "VIEW_CHANNEL",
"security": [
{
"bearer": []
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"403": {
"description": "No description available"
},
"404": {
"description": "No description available"
}
},
"parameters": [
{
"name": "channel_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "channel_id"
},
{
"name": "message_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "message_id"
}
],
"tags": [
"channels"
]
},
"delete": {
"security": [
{
"bearer": []
}
],
"responses": {
"204": {
"description": "No description available"
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"404": {
"description": "No description available"
}
},
"parameters": [
{
"name": "channel_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "channel_id"
},
{
"name": "message_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "message_id"
}
],
"tags": [
"channels"
]
}
},
"/channels/{channel_id}/messages/{message_id}/crosspost/": {
"post": {
"x-permission-required": "MANAGE_MESSAGES",
"security": [
{
"bearer": []
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"parameters": [
{
"name": "channel_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "channel_id"
},
{
"name": "message_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "message_id"
}
],
"tags": [
"channels"
]
}
},
"/channels/{channel_id}/messages/{message_id}/ack/": {
"post": {
"security": [
{
"bearer": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MessageAcknowledgeSchema"
}
}
}
},
"responses": {
"200": {
"description": "No description available"
},
"403": {
"description": "No description available"
}
},
"parameters": [
{
"name": "channel_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "channel_id"
},
{
"name": "message_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "message_id"
}
],
"tags": [
"channels"
]
}
},
"/channels/{channel_id}/invites/": {
"post": {
"x-right-required": "CREATE_INVITES",
"x-permission-required": "CREATE_INSTANT_INVITE",
"security": [
{
"bearer": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InviteCreateSchema"
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Invite"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"404": {
"description": "No description available"
}
},
"parameters": [
{
"name": "channel_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "channel_id"
}
],
"tags": [
"channels"
]
},
"get": {
"x-permission-required": "MANAGE_CHANNELS",
"security": [
{
"bearer": []
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIInviteArray"
}
}
}
},
"404": {
"description": "No description available"
}
},
"parameters": [
{
"name": "channel_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "channel_id"
}
],
"tags": [
"channels"
]
}
},
"/channels/{channel_id}/": {
"get": {
"x-permission-required": "VIEW_CHANNEL",
"security": [
{
"bearer": []
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Channel"
}
}
}
},
"404": {
"description": "No description available"
}
},
"parameters": [
{
"name": "channel_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "channel_id"
}
],
"tags": [
"channels"
]
},
"delete": {
"x-permission-required": "MANAGE_CHANNELS",
"security": [
{
"bearer": []
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Channel"
}
}
}
},
"404": {
"description": "No description available"
}
},
"parameters": [
{
"name": "channel_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "channel_id"
}
],
"tags": [
"channels"
]
},
"patch": {
"x-permission-required": "MANAGE_CHANNELS",
"security": [
{
"bearer": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChannelModifySchema"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Channel"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"404": {
"description": "No description available"
}
},
"parameters": [
{
"name": "channel_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "channel_id"
}
],
"tags": [
"channels"
]
}
},
"/auth/verify/view-backup-codes-challenge/": {
"post": {
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BackupCodesChallengeSchema"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BackupCodesChallengeResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"tags": [
"auth"
]
}
},
"/auth/verify/resend/": {
"post": {
"x-right-required": "RESEND_VERIFICATION_EMAIL",
"responses": {
"204": {
"description": "No description available"
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"500": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"tags": [
"auth"
]
}
},
"/auth/verify/": {
"post": {
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VerifyEmailSchema"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TokenResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorOrCaptchaResponse"
}
}
}
}
},
"tags": [
"auth"
]
}
},
"/auth/reset/": {
"post": {
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PasswordResetSchema"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TokenOnlyResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorOrCaptchaResponse"
}
}
}
}
},
"tags": [
"auth"
]
}
},
"/auth/register/": {
"post": {
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RegisterSchema"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TokenOnlyResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorOrCaptchaResponse"
}
}
}
}
},
"tags": [
"auth"
]
}
},
"/auth/mfa/webauthn/": {
"post": {
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebAuthnTotpSchema"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TokenResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"tags": [
"auth"
]
}
},
"/auth/mfa/totp/": {
"post": {
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TotpSchema"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TokenResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"tags": [
"auth"
]
}
},
"/auth/logout/": {
"post": {
"security": [
{
"bearer": []
}
],
"responses": {
"204": {
"description": "No description available"
}
},
"tags": [
"auth"
]
}
},
"/auth/login/": {
"post": {
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LoginSchema"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LoginResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorOrCaptchaResponse"
}
}
}
}
},
"tags": [
"auth"
]
}
},
"/auth/location-metadata/": {
"get": {
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LocationMetadataResponse"
}
}
}
}
},
"tags": [
"auth"
]
}
},
"/auth/generate-registration-tokens/": {
"get": {
"x-right-required": "OPERATOR",
"security": [
{
"bearer": []
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GenerateRegistrationTokensResponse"
}
}
}
}
},
"parameters": [
{
"name": "count",
"in": "query",
"schema": {
"type": "number"
},
"description": "The number of registration tokens to generate. Defaults to 1."
},
{
"name": "length",
"in": "query",
"schema": {
"type": "number"
},
"description": "The length of each registration token. Defaults to 255."
}
],
"tags": [
"auth"
]
}
},
"/auth/forgot/": {
"post": {
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForgotPasswordSchema"
}
}
}
},
"responses": {
"204": {
"description": "No description available"
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorOrCaptchaResponse"
}
}
}
},
"500": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"tags": [
"auth"
]
}
},
"/applications/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIApplicationArray"
}
}
}
}
},
"tags": [
"applications"
]
},
"post": {
"security": [
{
"bearer": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApplicationCreateSchema"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Application"
}
}
}
}
},
"tags": [
"applications"
]
}
},
"/applications/detectable/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApplicationDetectableResponse"
}
}
}
}
},
"tags": [
"applications"
]
}
},
"/applications/{id}/skus/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApplicationSkusResponse"
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "id"
}
],
"tags": [
"applications"
]
}
},
"/applications/{id}/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Application"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "id"
}
],
"tags": [
"applications"
]
},
"patch": {
"security": [
{
"bearer": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApplicationModifySchema"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Application"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "id"
}
],
"tags": [
"applications"
]
}
},
"/applications/{id}/delete": {
"post": {
"security": [
{
"bearer": []
}
],
"responses": {
"200": {
"description": "No description available"
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "id"
}
],
"tags": [
"applications"
]
}
},
"/applications/{id}/entitlements/": {
"get": {
"security": [
{
"bearer": []
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApplicationEntitlementsResponse"
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "id"
}
],
"tags": [
"applications"
]
}
},
"/applications/{id}/bot/": {
"post": {
"security": [
{
"bearer": []
}
],
"responses": {
"204": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TokenOnlyResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "id"
}
],
"tags": [
"applications"
]
},
"patch": {
"security": [
{
"bearer": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BotModifySchema"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Application"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "id"
}
],
"tags": [
"applications"
]
}
},
"/applications/{id}/bot/reset": {
"post": {
"security": [
{
"bearer": []
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TokenResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "id"
}
],
"tags": [
"applications"
]
}
},
"/-/readyz/": {
"get": {
"responses": {
"default": {
"description": "No description available"
}
},
"tags": [
"-"
]
}
},
"/-/healthz/": {
"get": {
"responses": {
"default": {
"description": "No description available"
}
},
"tags": [
"-"
]
}
}
}
}