feat: add Spectral rules to validate required operation channe and channel servers field #913
Conversation
smoya
requested review from
fmvilas,
magicmatatjahu,
jonaslagoni and
asyncapi-bot-eve
as code owners
| field: 'channel.$ref', | ||
| function: pattern, | ||
| functionOptions: { | ||
| match: '#\\/channels\\/', // If doesn't match, rule fails. |
There was a problem hiding this comment.
@fmvilas @jonaslagoni I simplified this by using this pattern function Spectral gives us. It allows to match by a regex applied to a field, in this case channel.$ref.
In consequence, I removed the function I created in favor of this.
smoya
changed the title
Oops, something might went wrong. Can you please check again?
|
|
@jonaslagoni @fmvilas FYI I've added to this PR also another rule that checks that the servers field of a required channel (under root) points to a subset of required (under root) servers. |
src/ruleset/v3/ruleset.ts
Outdated
| * Channel Object rules | ||
| */ | ||
| 'asyncapi3-required-channel-servers-unambiguity': { | ||
| description: 'The "servers" field of a channel under the root "channels" object must always reference to a subset of the servers under the root "servers" object.', |
There was a problem hiding this comment.
| description: 'The "servers" field of a channel under the root "channels" object must always reference to a subset of the servers under the root "servers" object.', | |
| description: 'The "servers" field of a channel under the root "channels" object must always reference a subset of the servers under the root "servers" object.', |
There was a problem hiding this comment.
fixed (didnt apply the suggestion because changes in the expected error msg in tests were needed)
|
Kudos, SonarCloud Quality Gate passed!
|
smoya
changed the title
|
/rtm |
|
🎉 This PR is included in version 3.0.0-next-major-spec.14 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Description
Part of asyncapi/spec#991
Despite the name of the branch, this PR adds two new Spectral rules (packed all together to minimize review efforts and to release asap).
This PR adds the last two new Spectral rules related with asyncapi/spec#991.
channelfield of a required operation (under root) points to a required (under root) channel and not to an optional (under components) channel, no matter if from the same document or from an external.serversfield of a required channel (under root) points to a subset of required (under root) servers.Related issue(s)
asyncapi/spec#991