OpenAPITools / OpenAPITools/openapi-generator

[BUG] [TypeScript-Axios] invalid code generation of anyOf

Open
#12,432 11 comments 11 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Client: TypeScript Issue: Bug
Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

Bug Report Checklist
  • Have you provided a full/minimal spec to reproduce the issue?
  • Have you validated the input using an OpenAPI validator (example)?
  • Have you tested with the latest master to confirm the issue still exists?
  • Have you searched for related issues/PRs?
  • What's the actual output vs expected output?
Description

With the latest master branch, the following spec does generate the wrong code.

upgradeTo:
                                    anyOf: [{properties: {purchasedPackageId: {$ref: '#/components/schemas/APITypeObjectId_APIObjectType.PurchasedPackage_'}, mode: {type: string, enum: [purchasedPackage], nullable: false}}, required: [purchasedPackageId, mode], type: object}, {properties: {packageId: {$ref: '#/components/schemas/APITypeObjectId_APIObjectType.BuyablePackage_'}, mode: {type: string, enum: [package], nullable: false}}, required: [packageId, mode], type: object}]
                                

What it should be (this is the original defiinitoin on our side)
image

But what it does:
image

so it's not purchasedPackageId OR packageId.. it is an AND.

It's the same if we use it without the "mode" paramter, then it's just merged into one (so also purchasedPackageId and packageId is required, instead of an OR).

openapi-generator version

6.0.0 - latest master snapshot
did work with 5.x

OpenAPI declaration file content or url

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reproducing the issue with the inline OpenAPI anyOf spec and the provided typescript-axios generation command. Compare the generated model with the expected image; done means the alternatives remain distinct, with purchasedPackageId and packageId treated as an OR rather than both being required.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi, typescript
Domain
api, tooling
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.