Add validation for use of 101 status code #237
Merged
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
mkistler
reviewed
Feb 17, 2021
| @@ -77,13 +77,20 @@ module.exports.validate = function({ resolvedSpec }, config) { | |||
| } | |||
| } | |||
| // validate all success codes | |||
| if (!successCodes.length) { | |||
| if (!successCodes.length && !("101" in obj)) { | |||
There was a problem hiding this comment.
I think I would have implemented this differently. I would have changed getResponseCodes to return 101 in successCodes, since we want to treat it like one. I'm curious why you chose this implementation instead.
There was a problem hiding this comment.
I actually did that first but it would have required changes to the check below that verifies that 204 is the only success code sans body.
There was a problem hiding this comment.
I'm good with this then. We shouldn't over-think this.
dpopp07
pushed a commit
that referenced
this pull request
Feb 18, 2021
## [0.34.2](v0.34.1...v0.34.2) (2021-02-18) ### Bug Fixes * add validation for use of 101 status code ([#237](#237)) ([52e1319](52e1319)) * run travis deploy step on main branch ([#239](#239)) ([6b5abbb](6b5abbb)) * update releaserc to use main branch ([#238](#238)) ([4b1569b](4b1569b)) * update semantic-release dependencies ([#240](#240)) ([6edf60c](6edf60c))
|
🎉 This PR is included in version 0.34.2 🎉 The release is available on: Your semantic-release bot 📦🚀 |
This was referenced Mar 8, 2021
This was referenced Mar 15, 2021
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.
Currently
101is not considered a success and therefore it's not valid for an operation to support101without also supporting a2xxcode. In fact, we'd prefer to validate that101MUST NOT be used along with a2xxresponse code.