Improve handling of oneOf and enum #1236
Merged
Conversation
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
🦋 Changeset detectedLatest commit: 45a79cb The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Deploying with
|
| Latest commit: |
45a79cb
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://92639452.openapi-ts.pages.dev |
| Branch Preview URL: | https://oneof-enum.openapi-ts.pages.dev |
drwpow
commented
Jul 21, 2023
| @@ -13321,7 +13323,7 @@ export interface components { | |||
| * Organization ruleset conditions | |||
| * @description Conditions for an organization ruleset | |||
| */ | |||
| "org-ruleset-conditions": (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-name-target"]) | (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-id-target"]); | |||
| "org-ruleset-conditions": Record<string, never> & ((components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-name-target"]) | (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-id-target"])); | |||
There was a problem hiding this comment.
Fortunately the Record<string, never> doesn’t interfere with the type at all; it’s just an empty object that gets ignored
drwpow
commented
Jul 21, 2023
| @@ -90333,15 +90335,97 @@ export interface operations { | |||
| }; | |||
| requestBody: { | |||
| content: { | |||
| "application/json": OneOf<[{ | |||
| "application/json": ({ | |||
There was a problem hiding this comment.
This is a big improvement, and a scenario where maybe we should start preferring practice over theory
drwpow
commented
Jul 21, 2023
| @@ -447,18 +447,21 @@ export type SchemaObject = { | |||
|
|
|||
| export interface StringSubtype { | |||
| type: "string"; | |||
| enum?: (string | ReferenceObject)[]; | |||
There was a problem hiding this comment.
I’m not completely happy with the enum type changes; we may need to change these in the future. But it just made this change easier.
Merged
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.
Changes
Before, if
oneOforenumwas present, we ignored the core type (for objects, at least). In this PR, we now create an intersection of the core type +oneOf/enum.The reason for the
enumhandling was although unconventional, I did find usage of it in the GitHub API schemas. And I couldn’t find any explicit signal that this is invalid. So just for object types, we’ll treatenum == oneOf.How to Review
Tests should pass.
Checklist
examples/directory updated (only applicable for openapi-typescript)