feat: add warning, non-204 success response should have response body #127
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
|
|
barrett-schonefeld
force-pushed
the
issue-560
branch
from
e0a2d01 to
1f22289
Compare
Codecov Report
@@ Coverage Diff @@
## master #127 +/- ##
==========================================
+ Coverage 92.65% 92.66% +0.01%
==========================================
Files 56 56
Lines 2055 2060 +5
==========================================
+ Hits 1904 1909 +5
Misses 151 151
Continue to review full report at Codecov.
|
dpopp07
requested changes
Feb 3, 2020
barrett-schonefeld
force-pushed
the
issue-560
branch
from
1f22289 to
95c6684
Compare
barrett-schonefeld
requested review from
dpopp07
and removed request for
mkistler
dpopp07
requested changes
Feb 5, 2020
There was a problem hiding this comment.
This looks great. I forgot one thing in my last review - I don't believe this rule is explicitly required by the OpenAPI Spec. Since that's the case, the rule should be documented and configurable. You will need to:
- Update the rules section of the readme
- Update the rule defaults section of the readme
- Update the defaults file
- Check for configuration when it's time to check for the rule
barrett-schonefeld
force-pushed
the
issue-560
branch
from
95c6684 to
fa08d63
Compare
barrett-schonefeld
force-pushed
the
issue-560
branch
from
fa08d63 to
bea76f2
Compare
barrett-schonefeld
force-pushed
the
issue-560
branch
from
bea76f2 to
76eb308
Compare
- added logic to check for response bodies in non-204 success responses in the oas3 plugin - added a test to check that a non-204 success response without response body generates a warning - added a test to check that multiple non-204 success responses without response bodies generates multiple warnings - updated the README.md to help users resolve potential issue with `npm run link` - fixed API definitions and tests that define a non-204 success without adding a response body - ran `npm run fix` to fix styling issues - updated variable names to be more clear - added to tests to compare expected messages and paths - added no_response_body rule and set the default value to 'warning'
barrett-schonefeld
force-pushed
the
issue-560
branch
from
76eb308 to
3a4e785
Compare
dpopp07
pushed a commit
that referenced
this pull request
Feb 7, 2020
# [0.18.0](v0.17.1...v0.18.0) (2020-02-07) ### Features * add warning, non-204 success response should have response body ([#127](#127)) ([90689c8](90689c8))
|
🎉 This PR is included in version 0.18.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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.
Related Issue: arf/planning-sdk-squad/issues/560
Changes:
npm run link