fix: Fix schema generation for oneOf when using TS-FETCH client#18154
Merged
macjohnny merged 2 commits intoOpenAPITools:masterfrom Mar 19, 2024
Merged
Conversation
This fixes the following errors: * Spread types may only be created from object types (on `FromJSONTyped` functions). * Module '"./BlankEnum"' has no exported member 'instanceOfBlankEnum' (enum templaces don't export function used by other API client files).
Contributor
Author
|
Pinging the members of the Typescript technical committee: @TiFu @taxpon @sebastianhaas @kenisteward @Vrolijkx @macjohnny @topce @akehir @petejohansonxo @amakhrov @davidgamero @mkusaka |
This was referenced Mar 18, 2024
macjohnny
approved these changes
Mar 19, 2024
Member
macjohnny
left a comment
There was a problem hiding this comment.
LGTM
thanks for your contribution
5 tasks
zapodot
pushed a commit
to zapodot/openapi-generator
that referenced
this pull request
Mar 21, 2024
…enAPITools#18154) * fix: Fix schema generation for `oneOf` when using TS-FETCH client This fixes the following errors: * Spread types may only be created from object types (on `FromJSONTyped` functions). * Module '"./BlankEnum"' has no exported member 'instanceOfBlankEnum' (enum templaces don't export function used by other API client files). * chore: Regenerate samples
Closed
6 tasks
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
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.
I'm using Django REST Framework + DRF Spectacular to automatically generate OpenAPI 3 schemas for my APIs.
When defining nullable enums, the API generator
typescript-fetchcreates code that doesn't compile properly with two errors:FromJSONTypedfunctions).There's a problem generating
typescript-fetchAPI clients using schemas containingoneOfand Enums.Some parts of the API client seem to rely on the
instaceOf{{classname}}, not provided for enum models.Also, the code tries to create spread types from function types, leading to a TS compilation error.
I'm not sure this is the best way to fix the issue, my OpenAPI generator internals knowledge is somewhat limited.
Testing instructions
tsc(target:es2017).Related issues
Module '"./MyEnum"' has no exported member 'instanceOfMyEnum'.andSpread types may only be created from object types.#15473oneOfcontainingenumtries to import nonexistent instanceOf function #14611PR checklist
Commit all changed files.
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
These must match the expectations made by your contribution.
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example
./bin/generate-samples.sh bin/configs/java*.IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
master(upcoming 7.1.0 minor release - breaking changes with fallbacks),8.0.x(breaking changes without fallbacks)