Trying to fix guild response schemas #1180
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
DEVTomatoCake
commented
Aug 17, 2024
| @@ -26,7 +26,6 @@ export interface GuildCreateSchema { | |||
| region?: string; | |||
| icon?: string | null; | |||
| channels?: ChannelModifySchema[]; | |||
| guild_template_code?: string; | |||
There was a problem hiding this comment.
This exists nowhere else...?
DEVTomatoCake
commented
Aug 17, 2024
| export interface GuildUpdateSchema | ||
| extends Omit<GuildCreateSchema, "channels" | "name"> { | ||
| name?: string; | ||
| export interface GuildUpdateSchema extends Omit<GuildCreateSchema, "channels"> { |
There was a problem hiding this comment.
Simplified this, the name property has the same type for both so why not reuse it.
|
When you can, could you fix the schema conflict, then I'll merge |
…rver into fix/guild-create-response-schema
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Initial bug: Creating a guild (
POST /api/guilds) returns a lot more properties than justid.Looking at this more, some schemas extended
Guildwhich caused them to include properties likesystem_channel(notsystem_channel_id) orchannel_ordering, both of which aren't returned in the response when stringifying a guild.I'm not really sure about using
| undefinedas type, it's used inIReadyGuildDTO- they might have to be marked as nullable/optional instead.Looking at the generated schema (replace with
spec-url="https://raw.githubusercontent.com/DEVTomatoCake/spacebar-server/fix/guild-create-response-schema/assets/openapi.json"in<rapi-doc>on https://docs.spacebar.chat/routes/#patch-/guilds/-guild_id-/) looks better.