Skip to content

fix: OAS3.1 deprecated property for array properties#23019

Merged
wing328 merged 2 commits intoOpenAPITools:masterfrom
plaflamme:typescript-deprecated-array
Feb 23, 2026
Merged

fix: OAS3.1 deprecated property for array properties#23019
wing328 merged 2 commits intoOpenAPITools:masterfrom
plaflamme:typescript-deprecated-array

Conversation

@plaflamme
Copy link
Copy Markdown
Contributor

@plaflamme plaflamme commented Feb 20, 2026

Found this problem in the typescript-axios generator, but it affects all of them, presumably, since the fix is in the OAS3.1 handler, not the typescript generator per-say. I did add a test to confirm the, new, correct behaviour in the typescript generator.

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 || exit
    ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
    ./bin/utils/export_docs_generators.sh || exit
    
    (For Windows users, please run the script in WSL)
    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.
  • File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR solves a reported issue, reference it using GitHub's linking syntax (e.g., having "fixes #123" present in the PR description)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

Summary by cubic

Fixes OAS 3.1 array schema normalization to preserve deprecated, readOnly, and writeOnly flags so generators correctly emit @deprecated for array properties. This resolves missing annotations in typescript-axios and applies to all generators using the OAS 3.1 normalizer.

  • Bug Fixes
    • Copy deprecated, readOnly, writeOnly when converting JsonSchema arrays to ArraySchema in OAS 3.1 normalization.
    • Added a TypeScript Axios test that verifies @deprecated on scalar, array-of-primitives, and array-of-refs properties.
    • No migration needed.

Written for commit d1c3c9e. Summary will update on new commits.

… OAS 3.1

The typescript-axios generator drops the @deprecated JSDoc annotation
for array-type properties when processing OpenAPI 3.1 specs. This test
reproduces the issue by asserting that deprecated scalar, array-of-primitives,
and array-of-refs properties all receive the annotation.
…1 array schemas

The OpenAPINormalizer.processNormalize31Spec method converts OAS 3.1
JsonSchema array types into legacy ArraySchema objects, but was not
copying the deprecated, readOnly, or writeOnly flags during conversion.
This caused @deprecated annotations to be silently dropped for array-type
properties in all generators when processing OAS 3.1 specs.
Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 3 files

@wing328 wing328 added Issue: Bug OpenAPI Normalizer Normalize the spec for easier processing labels Feb 23, 2026
@wing328 wing328 added this to the 7.21.0 milestone Feb 23, 2026
@wing328
Copy link
Copy Markdown
Member

wing328 commented Feb 23, 2026

thanks for the fix. lgtm

@wing328 wing328 merged commit 8fcb2e0 into OpenAPITools:master Feb 23, 2026
15 checks passed
@plaflamme plaflamme deleted the typescript-deprecated-array branch February 24, 2026 14:44
davidricodias pushed a commit to davidricodias/openapi-generator that referenced this pull request Mar 11, 2026
)

* test: add failing test for missing @deprecated on array properties in OAS 3.1

The typescript-axios generator drops the @deprecated JSDoc annotation
for array-type properties when processing OpenAPI 3.1 specs. This test
reproduces the issue by asserting that deprecated scalar, array-of-primitives,
and array-of-refs properties all receive the annotation.

* fix: preserve deprecated, readOnly, writeOnly when normalizing OAS 3.1 array schemas

The OpenAPINormalizer.processNormalize31Spec method converts OAS 3.1
JsonSchema array types into legacy ArraySchema objects, but was not
copying the deprecated, readOnly, or writeOnly flags during conversion.
This caused @deprecated annotations to be silently dropped for array-type
properties in all generators when processing OAS 3.1 specs.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Issue: Bug OpenAPI Normalizer Normalize the spec for easier processing

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants