feat: add Spectral rule to validate operation messages #911
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
smoya
requested review from
fmvilas,
magicmatatjahu,
jonaslagoni and
asyncapi-bot-eve
as code owners
smoya
commented
Nov 27, 2023
| const channelPointer = targetVal.channel?.$ref as string; // required | ||
|
|
||
| targetVal.messages?.forEach((message, index) => { | ||
| if (!message.$ref.startsWith(`${channelPointer}/messages`)) { |
There was a problem hiding this comment.
Is it that simple, or am I'm missing any edge case here? 🤔
|
Kudos, SonarCloud Quality Gate passed!
|
fmvilas
approved these changes
Nov 27, 2023
| const channelPointer = targetVal.channel?.$ref as string; // required | ||
|
|
||
| targetVal.messages?.forEach((message, index) => { | ||
| if (!message.$ref.startsWith(`${channelPointer}/messages`)) { |
jonaslagoni
approved these changes
Nov 27, 2023
|
🎉 This PR is included in version 3.0.0-next-major-spec.13 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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 all the scaffolding for adding Spectral rules to v3 plus the first of three new rules related with asyncapi/spec#991.
This rule, in particular, checks that operation messages, no matter where they are located, need to point to messages from the channel specified in its channel field.
Related issue(s)
asyncapi/spec#991