feat: add Spectral rule to validate required operation channel field #5
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
fmvilas
suggested changes
Nov 27, 2023
src/ruleset/v3/functions/requiredOperationChannelUnambiguity.ts
Outdated
Show resolved
Hide resolved
jonaslagoni
reviewed
Nov 27, 2023
| @@ -24,5 +25,18 @@ export const v3CoreRuleset = { | |||
| function: operationMessagesUnambiguity, | |||
| }, | |||
| }, | |||
| 'asyncapi3-required-operation-channel-unambiguity': { | |||
| description: 'Required operation (under root channels) "channel" must reference to a required channel (under root channels).', | |||
There was a problem hiding this comment.
Suggested change
| description: 'Required operation (under root channels) "channel" must reference to a required channel (under root channels).', | |
| description: 'Operation channel's must reference to a required channel (under root channels).', |
There was a problem hiding this comment.
src/ruleset/v3/functions/requiredOperationChannelUnambiguity.ts
Outdated
Show resolved
Hide resolved
Co-authored-by: Fran Méndez <fmvilas@gmail.com>
|
Closing in favor of asyncapi#913 |
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.
Description
Part of asyncapi/spec#991
This PR adds the second of two new rules related with asyncapi/spec#991.
This rule, in particular, checks that the
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.Important
This PR is pointing to
smoya/feat/v3OperationMessagesRulebecause is it there where all the scaffolding for supporting Spectral rules in v3 is located. Once asyncapi#911 is merged, I will close this PR and open a new one on the asyncapi repo.Related issue(s)
asyncapi/spec#991