Never create inline model for allOf with single $ref - #18945
Merged
Conversation
Member
|
Thanks for the PR but your commit (as shown in the Commits tab) is not linked to your Github account, which means this PR won't count as your contribution in https://github.com/OpenAPITools/openapi-generator/graphs/contributors. Let me know if you need help fixing it. |
Fixes OpenAPITools#15077 The previous fix for this in OpenAPITools#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.
Contributor
Author
Thanks for the note, I fixed the commit |
Member
|
tested locally to confirm the fix. --- a/.openapi-generator/FILES
+++ b/.openapi-generator/FILES
@@ -7,7 +7,6 @@ build.gradle
build.sbt
docs/DefaultApi.md
docs/Limits.md
-docs/LimitsAllOfRefWithDescriptionAndReadonly.md
docs/NumberRange.md
git_push.sh
gradle.properties
@@ -38,5 +37,4 @@ src/main/java/org/openapitools/client/auth/HttpBasicAuth.java
src/main/java/org/openapitools/client/auth/HttpBearerAuth.java
src/main/java/org/openapitools/client/model/AbstractOpenApiSchema.java
src/main/java/org/openapitools/client/model/Limits.java
-src/main/java/org/openapitools/client/model/LimitsAllOfRefWithDescriptionAndReadonly.java
src/main/java/org/openapitools/client/model/NumberRange.java |
|
@wing328 Hello, when will it be possible to get an update with this fix? |
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.
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-angulargenerator, but the issue is independent of any language-specific generator):The property
allOfRefWithDescriptionAndReadonlygenerates 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). ThereadOnlyproperty is completely ignored.Output with PR:
No unnecessary inline schema is created in all cases. The
allOfRefWithDescriptionAndReadonlycorrectly has its description included as a comment and has thereadonlymodifier 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)