feat: check for missing required properties #314
Conversation
Check for missing required properties in a schema and any subschemas.
barrett-schonefeld
force-pushed
the
missing-required-props
branch
from
d844380
to
4ae5ddf
Compare
Codecov Report
@@ Coverage Diff @@
## main #314 +/- ##
==========================================
- Coverage 92.01% 91.90% -0.11%
==========================================
Files 73 73
Lines 2378 2348 -30
Branches 607 598 -9
==========================================
- Hits 2188 2158 -30
Misses 157 157
Partials 33 33
Continue to review full report at Codecov.
|
| given: | ||
| - $.paths[*][*][parameters][*].schema | ||
| - $.paths[*][*][parameters,responses][*].content[*].schema | ||
| - $.paths[*][*][requestBody].content[*].schema |
There was a problem hiding this comment.
Is this operating on the resolved API definition? I see you're not checking inside of the components section, is that because we would expect to see all schemas where they are actually used?
There was a problem hiding this comment.
Yes, that's correct!
src/.defaultsForValidator.js
Outdated
| @@ -136,7 +135,8 @@ const defaults = { | |||
| */ | |||
| const deprecated = { | |||
| 'no_produces_for_get': 'no_produces', | |||
| 'parameters.snake_case_only': 'param_name_case_convention' | |||
| 'parameters.snake_case_only': 'param_name_case_convention', | |||
| 'undefined_required_properties': 'missing-required-property', | |||
There was a problem hiding this comment.
I forget how this value gets used (I think in a warning message) but it may be good to call out the fact that it's a spectral rule
There was a problem hiding this comment.
Good point! The key is the old rule, and the value is the replacement rule if it exists.
I could do something simple like use missing-required-property (Spectral rule), which will result in, "Use missing-required-property (Spectral rule) instead."
That might be confusing, though, so I could update the deprecation code to produce a different message when the new rule is a Spectral rule.
There was a problem hiding this comment.
I think that's fine, just something to indicate that the rule isn't going to be found in the validaterc file like the old one
There was a problem hiding this comment.
added the note in parentheses
barrett-schonefeld
force-pushed
the
missing-required-props
branch
from
cceddbd
to
48707aa
Compare
|
🎉 This PR is included in version 0.47.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Look for required properties that are not defined with the schema.
The
undefined_required_propertiesrule only looked in thecomponentssection, which is why it is deprecated.The new rule enforces that required properties are defined in a given requestBody, response, and parameter schema and in any subschemas.
Related issue: #311