Dekescordes/spacebar
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Trying to fix guild response schemas

Browse Source
This commit is contained in:
TomatoCake 2024-08-17 19:15:32 +02:00
parent bb31df036a
commit ff48d078e4
9 changed files with 95019 additions and 7829 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

453
assets/openapi.json
View File

@ -3892,6 +3892,138 @@
"description": "A container for useful snowflake-related methods.", "description": "A container for useful snowflake-related methods.",
"type": "object" "type": "object"
}, },
"GuildCreateResponse": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"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"
},
"template_id": {
"type": "string"
},
"mfa_level": {
"type": "integer"
},
"owner_id": {
"type": "string"
},
"premium_subscription_count": {
"type": "integer"
},
"premium_tier": {
"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"
},
"icon": {
"type": "string",
"nullable": true
},
"banner": {
"type": "string",
"nullable": true
},
"description": {
"type": "string"
},
"region": {
"type": "string"
},
"system_channel_id": {
"type": "string"
},
"rules_channel_id": {
"type": "string"
},
"afk_timeout": {
"type": "integer"
},
"explicit_content_filter": {
"type": "integer"
},
"splash": {
"type": "string",
"nullable": true
},
"features": {
"type": "array",
"items": {
"type": "string"
}
},
"verification_level": {
"type": "integer"
},
"default_message_notifications": {
"type": "integer"
},
"system_channel_flags": {
"type": "integer"
},
"public_updates_channel_id": {
"type": "string"
},
"afk_channel_id": {
"type": "string"
},
"preferred_locale": {
"type": "string"
},
"premium_progress_bar_enabled": {
"type": "boolean"
},
"discovery_splash": {
"type": "string"
}
},
"required": [
"id",
"name",
"nsfw",
"welcome_screen",
"widget_enabled"
]
},
"TenorGifResponse": { "TenorGifResponse": {
"type": "object", "type": "object",
"properties": { "properties": {
@ -4075,19 +4207,7 @@
"explicit_content_filter": { "explicit_content_filter": {
"type": "integer" "type": "integer"
}, },
"afk_channel_id": { "splash": {
"type": "string"
},
"bans": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Ban"
}
},
"default_message_notifications": {
"type": "integer"
},
"discovery_splash": {
"type": "string" "type": "string"
}, },
"features": { "features": {
@ -4096,6 +4216,36 @@
"type": "string" "type": "string"
} }
}, },
"verification_level": {
"type": "integer"
},
"default_message_notifications": {
"type": "integer"
},
"system_channel_flags": {
"type": "integer"
},
"public_updates_channel_id": {
"type": "string"
},
"afk_channel_id": {
"type": "string"
},
"preferred_locale": {
"type": "string"
},
"premium_progress_bar_enabled": {
"type": "boolean"
},
"discovery_splash": {
"type": "string"
},
"bans": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Ban"
}
},
"primary_category_id": { "primary_category_id": {
"type": "string" "type": "string"
}, },
@ -4141,27 +4291,12 @@
"mfa_level": { "mfa_level": {
"type": "integer" "type": "integer"
}, },
"preferred_locale": {
"type": "string"
},
"premium_subscription_count": { "premium_subscription_count": {
"type": "integer" "type": "integer"
}, },
"premium_tier": { "premium_tier": {
"type": "integer" "type": "integer"
}, },
"public_updates_channel_id": {
"type": "string"
},
"splash": {
"type": "string"
},
"system_channel_flags": {
"type": "integer"
},
"verification_level": {
"type": "integer"
},
"welcome_screen": { "welcome_screen": {
"$ref": "#/components/schemas/GuildWelcomeScreen" "$ref": "#/components/schemas/GuildWelcomeScreen"
}, },
@ -4177,9 +4312,6 @@
"permissions": { "permissions": {
"type": "integer" "type": "integer"
}, },
"premium_progress_bar_enabled": {
"type": "boolean"
},
"channel_ordering": { "channel_ordering": {
"type": "array", "type": "array",
"items": { "items": {
@ -5340,9 +5472,6 @@
"$ref": "#/components/schemas/ChannelModifySchema" "$ref": "#/components/schemas/ChannelModifySchema"
} }
}, },
"guild_template_code": {
"type": "string"
},
"system_channel_id": { "system_channel_id": {
"type": "string" "type": "string"
}, },
@ -5369,9 +5498,6 @@
"GuildUpdateSchema": { "GuildUpdateSchema": {
"type": "object", "type": "object",
"properties": { "properties": {
"name": {
"type": "string"
},
"banner": { "banner": {
"type": "string", "type": "string",
"nullable": true "nullable": true
@ -5419,6 +5545,10 @@
"discovery_splash": { "discovery_splash": {
"type": "string" "type": "string"
}, },
"name": {
"maxLength": 100,
"type": "string"
},
"icon": { "icon": {
"type": "string", "type": "string",
"nullable": true "nullable": true
@ -5426,9 +5556,6 @@
"region": { "region": {
"type": "string" "type": "string"
}, },
"guild_template_code": {
"type": "string"
},
"system_channel_id": { "system_channel_id": {
"type": "string" "type": "string"
}, },
@ -6262,7 +6389,21 @@
"type": "object", "type": "object",
"properties": { "properties": {
"guild_id": { "guild_id": {
"type": "string" "anyOf": [
{
"type": "array",
"items": [
{
"type": "string"
}
],
"minItems": 1,
"maxItems": 1
},
{
"type": "string"
}
]
}, },
"query": { "query": {
"type": "string" "type": "string"
@ -7297,17 +7438,6 @@
"user" "user"
] ]
}, },
"GuildCreateResponse": {
"type": "object",
"properties": {
"id": {
"type": "string"
}
},
"required": [
"id"
]
},
"GuildDiscoveryRequirementsResponse": { "GuildDiscoveryRequirementsResponse": {
"type": "object", "type": "object",
"properties": { "properties": {
@ -7761,7 +7891,7 @@
"type": "object", "type": "object",
"properties": { "properties": {
"guild": { "guild": {
"$ref": "#/components/schemas/Guild" "$ref": "#/components/schemas/GuildCreateResponse"
}, },
"emojis": { "emojis": {
"type": "array", "type": "array",
@ -8289,52 +8419,17 @@
"joined_at": { "joined_at": {
"type": "string" "type": "string"
}, },
"afk_channel_id": { "id": {
"type": "string" "type": "string"
}, },
"afk_channel": { "name": {
"$ref": "#/components/schemas/Channel"
},
"afk_timeout": {
"type": "integer"
},
"bans": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Ban"
}
},
"banner": {
"type": "string" "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": { "primary_category_id": {
"type": "string" "type": "string"
}, },
"icon": {
"type": "string"
},
"large": { "large": {
"type": "boolean", "type": "boolean"
"default": false
}, },
"max_members": { "max_members": {
"type": "integer" "type": "integer"
@ -8351,175 +8446,105 @@
"presence_count": { "presence_count": {
"type": "integer" "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": { "template_id": {
"type": "string" "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": { "mfa_level": {
"type": "integer" "type": "integer"
}, },
"name": {
"type": "string"
},
"owner_id": { "owner_id": {
"type": "string" "type": "string"
}, },
"owner": {
"$ref": "#/components/schemas/User"
},
"preferred_locale": {
"type": "string"
},
"premium_subscription_count": { "premium_subscription_count": {
"type": "integer" "type": "integer"
}, },
"premium_tier": { "premium_tier": {
"type": "integer" "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": { "welcome_screen": {
"$ref": "#/components/schemas/GuildWelcomeScreen" "$ref": "#/components/schemas/GuildWelcomeScreen"
}, },
"widget_channel_id": { "widget_channel_id": {
"type": "string" "type": "string"
}, },
"widget_channel": {
"$ref": "#/components/schemas/Channel"
},
"widget_enabled": { "widget_enabled": {
"type": "boolean", "type": "boolean"
"default": true
}, },
"nsfw_level": { "nsfw_level": {
"type": "integer" "type": "integer"
}, },
"nsfw": { "nsfw": {
"type": "boolean", "type": "boolean"
"default": false
}, },
"parent": { "parent": {
"type": "string" "type": "string"
}, },
"permissions": { "icon": {
"type": "string",
"nullable": true
},
"banner": {
"type": "string",
"nullable": true
},
"description": {
"type": "string"
},
"region": {
"type": "string"
},
"system_channel_id": {
"type": "string"
},
"rules_channel_id": {
"type": "string"
},
"afk_timeout": {
"type": "integer" "type": "integer"
}, },
"premium_progress_bar_enabled": { "explicit_content_filter": {
"type": "boolean", "type": "integer"
"default": false
}, },
"channel_ordering": { "splash": {
"type": "string",
"nullable": true
},
"features": {
"type": "array", "type": "array",
"items": { "items": {
"type": "string" "type": "string"
} }
}, },
"id": { "verification_level": {
"type": "integer"
},
"default_message_notifications": {
"type": "integer"
},
"system_channel_flags": {
"type": "integer"
},
"public_updates_channel_id": {
"type": "string"
},
"afk_channel_id": {
"type": "string"
},
"preferred_locale": {
"type": "string"
},
"premium_progress_bar_enabled": {
"type": "boolean"
},
"discovery_splash": {
"type": "string" "type": "string"
} }
}, },
"required": [ "required": [
"bans",
"channel_ordering",
"channels",
"emojis",
"features",
"id", "id",
"invites",
"joined_at", "joined_at",
"members",
"name", "name",
"nsfw", "nsfw",
"premium_progress_bar_enabled",
"public_updates_channel_id",
"roles",
"stickers",
"template",
"unavailable",
"voice_states",
"webhooks",
"welcome_screen", "welcome_screen",
"widget_enabled" "widget_enabled"
] ]
@ -14281,7 +14306,7 @@
"content": { "content": {
"application/json": { "application/json": {
"schema": { "schema": {
"$ref": "#/components/schemas/GuildUpdateSchema" "$ref": "#/components/schemas/GuildCreateResponse"
} }
} }
} }

102321
assets/schemas.json
View File

File diff suppressed because it is too large Load Diff

4
src/api/routes/guilds/#guild_id/index.ts
View File

@ -77,8 +77,8 @@ router.patch(
requestBody: "GuildUpdateSchema", requestBody: "GuildUpdateSchema",
permission: "MANAGE_GUILD", permission: "MANAGE_GUILD",
responses: { responses: {
"200": { 200: {
body: "GuildUpdateSchema", body: "GuildCreateResponse",
}, },
401: { 401: {
body: "APIErrorResponse", body: "APIErrorResponse",

4
src/util/interfaces/Event.ts
View File

@ -28,7 +28,6 @@ import {
Role, Role,
Emoji, Emoji,
PublicMember, PublicMember,
Guild,
Channel, Channel,
PublicUser, PublicUser,
User, User,
@ -43,6 +42,7 @@ import {
ReadyUserGuildSettingsEntries, ReadyUserGuildSettingsEntries,
ReadyPrivateChannel, ReadyPrivateChannel,
GuildOrUnavailable, GuildOrUnavailable,
GuildCreateResponse,
} from "@spacebar/util"; } from "@spacebar/util";
export interface Event { export interface Event {
@ -195,7 +195,7 @@ export interface GuildCreateEvent extends Event {
export interface GuildUpdateEvent extends Event { export interface GuildUpdateEvent extends Event {
event: "GUILD_UPDATE"; event: "GUILD_UPDATE";
data: Guild; data: GuildCreateResponse;
} }
export interface GuildDeleteEvent extends Event { export interface GuildDeleteEvent extends Event {

1
src/util/schemas/GuildCreateSchema.ts
View File

@ -26,7 +26,6 @@ export interface GuildCreateSchema {
region?: string; region?: string;
icon?: string | null; icon?: string | null;
channels?: ChannelModifySchema[]; channels?: ChannelModifySchema[];
guild_template_code?: string;
system_channel_id?: string; system_channel_id?: string;
rules_channel_id?: string; rules_channel_id?: string;
} }

4
src/util/schemas/GuildUpdateSchema.ts
View File

@ -18,9 +18,7 @@
import { GuildCreateSchema } from "@spacebar/util"; import { GuildCreateSchema } from "@spacebar/util";
export interface GuildUpdateSchema export interface GuildUpdateSchema extends Omit<GuildCreateSchema, "channels"> {
extends Omit<GuildCreateSchema, "channels" | "name"> {
name?: string;
banner?: string | null; banner?: string | null;
splash?: string | null; splash?: string | null;
description?: string; description?: string;

23
src/util/schemas/responses/GuildCreateResponse.ts
View File

@ -16,6 +16,27 @@
along with this program. If not, see <https://www.gnu.org/licenses/>. along with this program. If not, see <https://www.gnu.org/licenses/>.
*/ */
export interface GuildCreateResponse { import { GuildUpdateSchema, GuildWelcomeScreen } from "@spacebar/util";
export interface GuildCreateResponse extends Omit<GuildUpdateSchema, "name"> {
id: string; id: string;
name: string;
primary_category_id: string | undefined;
large: boolean | undefined;
max_members: number | undefined;
max_presences: number | undefined;
max_video_channel_users: number | undefined;
member_count: number | undefined;
presence_count: number | undefined;
template_id: string | undefined;
mfa_level: number | undefined;
owner_id: string | undefined;
premium_subscription_count: number | undefined;
premium_tier: number | undefined;
welcome_screen: GuildWelcomeScreen;
widget_channel_id: string | undefined;
widget_enabled: boolean;
nsfw_level: number | undefined;
nsfw: boolean;
parent: string | undefined;
} }

5
src/util/schemas/responses/MemberJoinGuildResponse.ts
View File

@ -16,10 +16,11 @@
along with this program. If not, see <https://www.gnu.org/licenses/>. along with this program. If not, see <https://www.gnu.org/licenses/>.
*/ */
import { Emoji, Guild, Role, Sticker } from "../../entities"; import { GuildCreateResponse } from "@spacebar/util";
import { Emoji, Role, Sticker } from "../../entities";
export interface MemberJoinGuildResponse { export interface MemberJoinGuildResponse {
guild: Guild; guild: GuildCreateResponse;
emojis: Emoji[]; emojis: Emoji[];
roles: Role[]; roles: Role[];
stickers: Sticker[]; stickers: Sticker[];

3
src/util/schemas/responses/TypedResponses.ts
View File

@ -16,6 +16,7 @@
along with this program. If not, see <https://www.gnu.org/licenses/>. along with this program. If not, see <https://www.gnu.org/licenses/>.
*/ */
import { GuildCreateResponse } from "@spacebar/util";
import { GeneralConfiguration, LimitsConfiguration } from "../../config"; import { GeneralConfiguration, LimitsConfiguration } from "../../config";
import { DmChannelDTO } from "../../dtos"; import { DmChannelDTO } from "../../dtos";
import { import {
@ -89,7 +90,7 @@ export type APIEmojiArray = Emoji[];
export type APIMemberArray = Member[]; export type APIMemberArray = Member[];
export type APIPublicMember = PublicMember; export type APIPublicMember = PublicMember;
export interface APIGuildWithJoinedAt extends Guild { export interface APIGuildWithJoinedAt extends GuildCreateResponse {
joined_at: string; joined_at: string;
} }