[BUG][typescript-axios] oneOf models drop sibling properties

未关闭
  • 哪里不对？
#25,635 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

@Justineo 已经在做这个了。

开始于 2026年11月12日。

  • #25636 来自 @Justineo —— 未关闭

评估

难度
4/5
预计耗时
3-5 天
新手友好度
35/100
Issue 类型
缺陷
描述清晰度
描述清楚
活跃度
停滞
技术栈
openapi, typescript
领域
backend-api-design, tooling

调研方向

Start with the standalone fixture at modules/openapi-generator/src/test/resources/3_0/typescript-axios/oneof-sibling-properties.yaml and the TypeScript Axios generator tests, especially TypeScriptAxiosClientCodegenTest. Compare generated Receipt and TaggedReceipt with the expected sibling properties, then trace how oneOf models are rendered and how sibling properties, enums, and referenced models are represented. Done means the regression cases pass without requiring properties from the oneOf branches.

由索引模型根据 Issue 内容生成。

描述

Bug Report Checklist
  • Provided a minimal, standalone spec.
  • Validated the input with the generator's validate command (no validation errors; one unused-model recommendation).
  • Reproduced with the latest master.
  • Searched related issues and PRs.
  • Included actual and expected output.
Description

The typescript-axios generator drops properties declared alongside oneOf. For example, a response schema can add an id to alternatives that are also used as request bodies:

Receipt:
  type: object
  required: [id]
  properties:
    id:
      type: string
  oneOf:
    - $ref: '#/components/schemas/TextSubmission'
    - $ref: '#/components/schemas/LinkSubmission'

Actual:

export type Receipt = LinkSubmission | TextSubmission;

Expected:

export type Receipt = (LinkSubmission | TextSubmission) & {
    'id': string;
};

The missing property prevents consumers from reading response.data.id through the generated SDK. Adding it to the shared alternatives would incorrectly require response metadata in request bodies.

openapi-generator version

Reproduced with 7.27.0 and master at df804ac9802fba0c51a64f8c3cb03191ed3dde2d (7.28.0-SNAPSHOT). Four regression cases fail against unmodified master: combined/separate model files, each with constant-object/string enums. The other 15 tests in TypeScriptAxiosClientCodegenTest pass.

OpenAPI declaration file content or url

Standalone OpenAPI 3.0.3 fixture

The fixture also covers enum properties, a referenced sibling model, nullable optional properties, and a discriminator.

Generation Details
java -jar openapi-generator-cli.jar generate \
  -g typescript-axios \
  -i oneof-sibling-properties.yaml \
  -o generated
Steps to reproduce
  1. Download the standalone fixture.
  2. Generate with the command above.
  3. Inspect Receipt and TaggedReceipt in generated/api.ts: their sibling fields are missing.
Related issues/PRs

Searched the TypeScript Axios composition issues and PRs, including #8894 (anyOf semantics) and #22870 (additional composition tests). Those address different cases.

Suggest a fix

Render the union as an intersection with only its sibling properties. The internal vars list also contains branch properties, so rendering all of it would incorrectly require fields from every alternative. Preserve enum declarations and imports for referenced sibling models.

AI disclosure — Codex

Codex investigated the generator, prepared the standalone reproduction, ran the checks above, and drafted this report. I supplied the problem and requested an upstream fix.

主要语言
Java
星标
26.9k
派生
7.8k
平均合并
2 天 10 小时
30 天内合并 PR
180

环境准备

在 Codespaces 中打开

在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

OpenAPITools/openapi-generator 的其他 Issue

查看 OpenAPITools/openapi-generator 的全部 Issue

相似的 Issue

更多 Java Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。