-
-
Couldn't load subscription status.
- Fork 414
fix: union when there are multiple request/response types defined #1462
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
stefan-cooper
wants to merge
4
commits into
acacode:main
Choose a base branch
from
stefan-cooper:314/fix
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| "swagger-typescript-api": minor | ||
| --- | ||
|
|
||
| Add support for multiple request/response types to be defined as unions |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -331,16 +331,55 @@ export class SchemaRoutes { | |||||||||||||||||||
|
|
||||||||||||||||||||
| /* content: { "multipart/form-data": { schema: {...} }, "application/json": { schema: {...} } } */ | ||||||||||||||||||||
|
|
||||||||||||||||||||
| /* for example: dataType = "multipart/form-data" */ | ||||||||||||||||||||
| const contentTypes = Object.keys(content); | ||||||||||||||||||||
|
|
||||||||||||||||||||
| // if there's only one content type, return it | ||||||||||||||||||||
| if (contentTypes.length === 1 && content[contentTypes[0]]?.schema) { | ||||||||||||||||||||
| return { | ||||||||||||||||||||
| ...content[contentTypes[0]].schema, | ||||||||||||||||||||
| dataType: contentTypes[0], | ||||||||||||||||||||
| }; | ||||||||||||||||||||
| } | ||||||||||||||||||||
|
|
||||||||||||||||||||
| // Check if there are multiple media types with schemas | ||||||||||||||||||||
| const schemasWithDataTypes = []; | ||||||||||||||||||||
| for (const dataType in content) { | ||||||||||||||||||||
| if (content[dataType]?.schema) { | ||||||||||||||||||||
| return { | ||||||||||||||||||||
| schemasWithDataTypes.push({ | ||||||||||||||||||||
| ...content[dataType].schema, | ||||||||||||||||||||
| dataType, | ||||||||||||||||||||
| }; | ||||||||||||||||||||
| }); | ||||||||||||||||||||
| } | ||||||||||||||||||||
| } | ||||||||||||||||||||
|
|
||||||||||||||||||||
| // If there's only one schema, return it directly | ||||||||||||||||||||
| if (schemasWithDataTypes.length === 1) { | ||||||||||||||||||||
| return schemasWithDataTypes[0]; | ||||||||||||||||||||
| } | ||||||||||||||||||||
|
|
||||||||||||||||||||
| // If there are multiple schemas with different structures, create a oneOf schema to generate a union type | ||||||||||||||||||||
| if (schemasWithDataTypes.length > 1) { | ||||||||||||||||||||
| // Check if all schemas are structurally the same | ||||||||||||||||||||
| // If they are, just return the first one | ||||||||||||||||||||
| const firstSchema = schemasWithDataTypes[0]; | ||||||||||||||||||||
| const allSchemasAreSame = schemasWithDataTypes.every((schema) => | ||||||||||||||||||||
| lodash.isEqual( | ||||||||||||||||||||
| lodash.omit(schema, "dataType"), | ||||||||||||||||||||
| lodash.omit(firstSchema, "dataType"), | ||||||||||||||||||||
|
Comment on lines
+365
to
+368
|
||||||||||||||||||||
| const allSchemasAreSame = schemasWithDataTypes.every((schema) => | |
| lodash.isEqual( | |
| lodash.omit(schema, "dataType"), | |
| lodash.omit(firstSchema, "dataType"), | |
| const firstSchemaOmitted = lodash.omit(firstSchema, "dataType"); | |
| const allSchemasAreSame = schemasWithDataTypes.every((schema) => | |
| lodash.isEqual( | |
| lodash.omit(schema, "dataType"), | |
| firstSchemaOmitted, |
This file contains hidden or 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
This file contains hidden or 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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The logic for handling single content types is duplicated: lines 337-342 handle the case where
contentTypes.length === 1, and lines 356-358 handle the case whereschemasWithDataTypes.length === 1. These blocks will always produce the same result when there's only one schema. The first check (lines 337-342) should be removed since the loop and subsequent check (lines 346-358) already handle this case correctly.