Skip to content
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

[Typescript] Generate oneOf schemas as type unions #19027

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

ksvirkou-hubspot
Copy link
Contributor

@ksvirkou-hubspot ksvirkou-hubspot commented Jun 27, 2024

Description of the PR

Generate type unions for schemas represented with oneOf format
as #2617 but for typescript generator
Sample input:

"inputFieldDependencies": {
   "type": "array",
   "items":{
      "oneOf":[
         {
            "$ref":"#/components/schemas/SingleFieldDependency"
         },
         {
            "$ref":"#/components/schemas/ConditionalSingleFieldDependency"
         }
      ]
   }
}

Sample output:

import { PublicConditionalSingleFieldDependency } from '../models/SingleFieldDependency';
import { PublicSingleFieldDependency } from '../models/ConditionalSingleFieldDependency';

export type PublicActionDefinitionInputFieldDependenciesInner = SingleFieldDependency | ConditionalSingleFieldDependency;

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package 
    ./bin/generate-samples.sh ./bin/configs/*.yaml
    ./bin/utils/export_docs_generators.sh
    
  • File the PR against the correct branch: master (upcoming 7.6.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

Related issues:

#9305

@ksvirkou-hubspot
Copy link
Contributor Author

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant