fix: OAS3.1 deprecated property for array properties#23019
Merged
wing328 merged 2 commits intoOpenAPITools:masterfrom Feb 23, 2026
Merged
fix: OAS3.1 deprecated property for array properties#23019wing328 merged 2 commits intoOpenAPITools:masterfrom
wing328 merged 2 commits intoOpenAPITools:masterfrom
Conversation
… 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.
Member
|
thanks for the fix. lgtm |
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.
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.
Found this problem in the
typescript-axiosgenerator, 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
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
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.
Written for commit d1c3c9e. Summary will update on new commits.