Never create inline model for allOf with single $ref #18945
Merged
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.
Fixes #15077
The previous fix for this in #16096 is incomplete because it still generates unnecessary inline models when readOnly or nullable is used in conjunction with other properties like description.
This commit fixes the logic error and adds testcases.
Schema (full schema is included
issue_15077.yaml
):Previous output (excerpt from output using
typescript-angular
generator, but the issue is independent of any language-specific generator):The property
allOfRefWithDescriptionAndReadonly
generates an unnecessary inline schema that is a copy ofNumberRange
. The description is also missing from the property (and is instead applied to the generated inline model). ThereadOnly
property is completely ignored.Output with PR:
No unnecessary inline schema is created in all cases. The
allOfRefWithDescriptionAndReadonly
correctly has its description included as a comment and has thereadonly
modifier set.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
(upcoming 7.6.0 minor release - breaking changes with fallbacks),8.0.x
(breaking changes without fallbacks)