fix(parameters): applied extra schema validation to parameters #166
Conversation
This file contains 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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #166 +/- ##
==========================================
+ Coverage 91.47% 92.40% +0.92%
==========================================
Files 22 22
Lines 2978 2987 +9
==========================================
+ Hits 2724 2760 +36
+ Misses 202 182 -20
+ Partials 52 45 -7
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
fredbi
added a commit
to fredbi/go-swagger
that referenced
this pull request
Dec 23, 2023
* fixes go-swagger#2527 * requires go-openapi/validate#166 TODO: add unit tests Signed-off-by: Frederic BIDON <fredbi@yahoo.com>
fredbi
force-pushed
the
fix/165-extra-schema-validation-for-params
branch
from
2942f19
to
7ca958e
Compare
fredbi
added a commit
to fredbi/go-swagger
that referenced
this pull request
Dec 24, 2023
* fixes go-swagger#2527 * requires go-openapi/validate#166 TODO: add unit tests Signed-off-by: Frederic BIDON <fredbi@yahoo.com>
youyuanwu
reviewed
Dec 26, 2023
youyuanwu
approved these changes
Dec 26, 2023
This PR applies an extra jsonschema validation to expanded parameters. Whenever a parameter is provided as a $ref, jsonschema validation works at the level of the unexpanded parameter only. It is indeed valid to declare a parameter as a json reference. The issue is that the expanded content of this parameter definition is subject only to "extra rules" (uniqueness, etc) and not to the basic jsonschema rules (e.g. allowed and required properties). An example is provided by go-swagger/go-swagger#2527. It seems that this situation never occured before go-swagger/go-swagger#2527 because the "parameters" section to which shared parameters normally point to is always fully expanded. In the case of a $ref to a schema in "definition", the invalid content of the $ref incorrectly passes validation. * fixes go-openapi#165 * contributes go-swagger/go-swagger#2527 Signed-off-by: Frederic BIDON <fredbi@yahoo.com>
Signed-off-by: Frederic BIDON <fredbi@yahoo.com>
fredbi
force-pushed
the
fix/165-extra-schema-validation-for-params
branch
from
7ca958e
to
94f064e
Compare
fredbi
changed the title
fredbi
added a commit
to fredbi/go-swagger
that referenced
this pull request
Dec 27, 2023
* Added unit tests to assert that invalid parameters in spec are indeed detected (i) by spec validation, (ii) by codegen when validation is skipped. * Refactored a bit client codegen tests * fixes go-swagger#2527 * requires go-openapi/validate#166 Signed-off-by: Frederic BIDON <fredbi@yahoo.com>
fredbi
added a commit
to fredbi/go-swagger
that referenced
this pull request
Dec 27, 2023
* Added unit tests to assert that invalid parameters in spec are indeed detected (i) by spec validation, (ii) by codegen when validation is skipped. * Refactored a bit client codegen tests * fixes go-swagger#2527 * requires go-openapi/validate#166 Signed-off-by: Frederic BIDON <fredbi@yahoo.com>
fredbi
added a commit
to go-swagger/go-swagger
that referenced
this pull request
Dec 27, 2023
* Added unit tests to assert that invalid parameters in spec are indeed detected (i) by spec validation, (ii) by codegen when validation is skipped. * Refactored a bit client codegen tests * fixes #2527 * requires go-openapi/validate#166 Signed-off-by: Frederic BIDON <fredbi@yahoo.com>
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.
This PR applies an extra jsonschema validation to expanded parameters.
Whenever a parameter is provided as a $ref, jsonschema validation works at the level of the unexpanded parameter only. It is indeed valid to declare a parameter as a json reference. The issue is that the contents of this parameter definition are subject only to "extra rules" (uniqueness, etc) and not the basic jsonschema rules (e.g. required properties).
An example is provided by go-swagger/go-swagger#2527.
It seems that this situation never occured before go-swagger/go-swagger#2527 because the "parameters" section to which shared parameters normally point to is always fully expanded.
In the case of a $ref to a schema in "definition", the invalid content of the $ref incorrectly passes validation.