adds discriminator validator to conform to openAPI 2 and 3 specifications #107
Conversation
…ifications The Swagger 2.0 spec says 'The [discriminator] property name used MUST be defined at this schema'. The validator currently does not flag violations of this requirement
|
|
| const errors = []; | ||
| const warnings = []; | ||
|
|
||
| const schemas = jsSpec.components.schemas; |
There was a problem hiding this comment.
Schemas can appear in places other than components/schemas, e.g. in request and response bodies, but for this validation it might be reasonable to just check components/schemas.
| const { discriminator } = schema; | ||
|
|
||
| // If discriminator is not an object, error out and return | ||
| if (typeof discriminator === 'object') { |
There was a problem hiding this comment.
In OpenAPI 2.0, the discriminator is just a string property containing the name of the discriminator property in the schema. So what you have done here is correct for OpenAPI 3.0 but not for OpenAPI 2.0.
There are two ways to address this: 1) use alternate paths in this validator for OAS2 vs OAS3, or 2) move this validation to OAS3, and implement a separate (but very similar) validator for OAS2 (aka Swagger).
| 'The discriminator property name used must be defined in this schema' | ||
| ); | ||
| }); | ||
| }); |
Codecov Report
@@ Coverage Diff @@
## master #107 +/- ##
==========================================
+ Coverage 92.09% 92.32% +0.22%
==========================================
Files 53 55 +2
Lines 1886 1941 +55
==========================================
+ Hits 1737 1792 +55
Misses 149 149
Continue to review full report at Codecov.
|
| .concat([schemaName, 'discriminator', 'propertyName']) | ||
| .join('.'), | ||
| message: | ||
| '`propertName` inside discriminator object must be of type string' |
There was a problem hiding this comment.
Typo here: "propertName" -> "propertyName"
# [0.15.0](v0.14.0...v0.15.0) (2019-10-01) ### Features * validate discriminator properties conform to specifications ([#107](#107)) ([0ecd539](0ecd539))
|
🎉 This PR is included in version 0.15.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
The Swagger 2.0 spec and Open API 3 spec says 'The [discriminator] property name used MUST be defined at this schema'.
The validator currently does not flag violations of this requirement