Inline response schemas with additionalProperties with boolean values are no longer ignored#9891
Open
twof wants to merge 3 commits intoswagger-api:masterfrom
Open
Inline response schemas with additionalProperties with boolean values are no longer ignored#9891twof wants to merge 3 commits intoswagger-api:masterfrom
twof wants to merge 3 commits intoswagger-api:masterfrom
Conversation
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.
PR checklist
./bin/to update Petstore sample so that CIs can verify the change. (For instance, only need to run./bin/{LANG}-petstore.shand./bin/security/{LANG}-petstore.shif updating the {LANG} (e.g. php, ruby, python, etc) code generator or {LANG} client's mustache templates). Windows batch files can be found in.\bin\windows\.3.0.0branch for changes related to OpenAPI spec 3.0. Default:master.Description of the PR
This is meant to be released in the next v2.4.x release. It's branched off of the v2.4.10 tag. This PR resolves #9885
My understanding is that
additionalPropertiesfields with boolean values should be ignored, as they are not explicitly in or against the OpenAPI 2/3 spec. However in the current V2.4.x and v3.0.x releases, if anadditionalPropertiesfield with a boolean value is contained within an inline response schema, the response model is never added to the list of definitions onswagger.definitionswhich causesswagger-codegento fail to generate it.That is because they're treated as
UntypedPropertywhich previously wasn't a handled case. This PR adds a case foradditionalPropertiesto be anUntypedProperty, and effectively ignores the value ofadditionalProperties.Let me know if yall (the maintainers) think this is a good solution or if you have any additional feedback. Java isn't my primary language, so apologies if I've broken conventions.
Thanks!
(details of the change, additional tests that have been done, reference to the issue for tracking, etc)
#9885