Correctly validate 204 responses #133
Open
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
tristanoneil
force-pushed
the
204-validation
branch
from
d714b99
to
a8d6e00
Compare
dpashkevich
reviewed
Mar 30, 2022
| @@ -21,9 +21,11 @@ def validate(response_body, response_validate_options) | |||
|
|
|||
| media_type = select_media_type(response_body.content_type) | |||
| unless media_type | |||
| raise ::OpenAPIParser::NotExistContentTypeDefinition, object_reference if response_validate_options.strict | |||
| if response_validate_options.strict && response_body.status_code != 204 | |||
There was a problem hiding this comment.
I think a more universal solution would be to not do content-type validation if the response body is empty, regardless of what the status code is, e.g.
Suggested change
| if response_validate_options.strict && response_body.status_code != 204 | |
| if response_validate_options.strict && response_body_not_blank |
This is conceptually similar to the fix used in https://github.com/openapi-library/OpenAPIValidators/pull/59/files
There was a problem hiding this comment.
Thanks, good call! I fixed up 69c8c9a.
added 2 commits
March 30, 2022 19:47
Empty response bodies (204 responses for instance) should not have a content type and therefore an error should not be raised in strict mode when the response body is empty and the content type is nil as this behavior is expected.
As mentioned in ota42y#101 it makes more sense to return true from this method when validation passes instead of nil.
tristanoneil
force-pushed
the
204-validation
branch
from
a8d6e00
to
e667d54
Compare
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 fix should resolve #101 in that it'll return
trueinstead ofnilwhen validation passes. This also ensures that an error is not raised when in strict mode when the status code is204and the content type isnilsince that should be the expected behavior.