feat: Validate missing response description #186
Conversation
| `A ${statusCode} response should include a description.`, | ||
| 'error' | ||
| ); | ||
| } |
There was a problem hiding this comment.
This looks good. I actually think we should move this check up to line 55 since this is required of all responses, not just success responses.
rmkeezer
force-pushed
the
missing_response_description
branch
2 times, most recently
from
b9f5fb5
to
bb500d6
Compare
| @@ -52,6 +52,13 @@ module.exports.validate = function({ resolvedSpec }, config) { | |||
| } else { | |||
| // default warnings for discouraged status code per IBM API Handbook | |||
There was a problem hiding this comment.
Okay I have to be a little obnoxious here but for the sake of clarity, this comment should be moved to be just before if (statusCode === '422') {. Those are the checks the comment describes, so it is a little confusing to leave here as if it applies to everything.
| if (!obj[statusCode].description) { | ||
| messages.addMessage( | ||
| path.concat([statusCode]), | ||
| `A ${statusCode} response should include a description.`, |
There was a problem hiding this comment.
I didn't look at this close enough last time - because this check is an unconditional requirement and applies to every response, this message is slightly misleading. I think it should be changed to
| `A ${statusCode} response should include a description.`, | |
| 'All responses must include a description.', |
rmkeezer
force-pushed
the
missing_response_description
branch
from
bb500d6
to
dda9a63
Compare
# [0.29.0](v0.28.1...v0.29.0) (2020-08-11) ### Features * Validate missing response descriptions ([#186](#186)) ([751c18d](751c18d))
|
🎉 This PR is included in version 0.29.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Throw error when a description is missing for any response schema since failing to do so will cause a compilier error.