[typescript-fetch] Fix nested oneOf generating uncompilable interface extends on union type#23501
Open
jasperpatterson wants to merge 1 commit intoOpenAPITools:masterfrom
Open
[typescript-fetch] Fix nested oneOf generating uncompilable interface extends on union type#23501jasperpatterson wants to merge 1 commit intoOpenAPITools:masterfrom
interface extends on union type#23501jasperpatterson wants to merge 1 commit intoOpenAPITools:masterfrom
Conversation
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.
When a
oneOfdiscriminated union has a variant that references anotheroneOfviaallOf(nested discriminated unions), the generator producesinterface Child extends ParentwhereParentis a TypeScript union type. This fails to compile with TS2312: "An interface can only extend an object type or intersection of object types with statically known members."For example, given an outer
oneOfdiscriminated byouterDiscriminatorwhere one variant composes (viaallOf) a fixed discriminator value with a$refto an inneroneOfdiscriminated byinnerDiscriminator:Before:
After:
Changes
TypeScriptFetchClientCodegen.java: InpostProcessAllModels(), detect when a model's parent is aoneOfmodel and set aparentIsOneOfflag on the model.modelGenericInterfaces.mustache: WhenparentIsOneOfis true, emitexport type X = Parent & { ... };instead ofexport interface X extends Parent { ... }. Models with non-oneOf parents are unaffected.TypeScriptFetchClientCodegenTest.java: New test verifying the composed variant uses a type alias, the inner/outer discriminator dispatch is preserved, and plain models still generate as interfaces.nested-oneOf.yaml: Test spec exercising the nested discriminated union pattern.PR 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(upcoming7.x.0minor release - breaking changes with fallbacks),8.0.x(breaking changes without fallbacks)"fixes #123"present in the PR description)Summary by cubic
Fix TS2312 compile errors in the TypeScript Fetch generator when a model extends a
oneOfunion. Models with aoneOfparent now emittype X = Parent & { ... }instead ofinterface X extends Parent.oneOfparents during post-processing and setparentIsOneOf, switching the template to emit an intersection type alias.nested-oneOf.yamlspec to verify the alias is used, discriminators still dispatch correctly, and non-oneOfparents still generateinterface.Written for commit b4a4ecf. Summary will update on new commits.