-
-
Notifications
You must be signed in to change notification settings - Fork 93
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Some Spectral Rules for spec v3 should run after resolving references #924
Comments
This issue has been automatically marked as stale because it has not had recent activity 😴 It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation. There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model. Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here. Thank you for your patience ❤️ |
Describe the bug
Both
asyncapi3-required-operation-channel-unambiguity
andasyncapi3-required-channel-servers-unambiguity
rules (found here) apply at this moment to the unresolved document, meaning they run when the JSON References ($ref) are not yet resolved.That was made in this way because it simplifies a lot the logic; we just need to match a pattern to the JSON pointer and voilà!.
However, that simplicity has a cost.
This validation works perfectly when any of the references found in
channel.servers
oroperation.channel
point to the same file.However, if any point to an external file, the validation might not work as expected. See the next section where you will find an example that illustrate this.
How to Reproduce
b.yaml
is an invalid document, as explained in the comment of the yaml file. And the parser shows that error when that document is validated.However,
a.yaml
, which is referencing an invalid channel fromb.yaml
file, won't fail validation.The reason is that the validation is made by matching that the JSON pointer references to the root object. I.e. for
operation.channel
, the pointer should contain the#/channels/
literal.Expected behavior
The
a.yaml
located in the previous example should be considered as invalid by the parser.I think the only way to achieve this is to make the rules pass when the document is unresolved.
cc @fmvilas @jonaslagoni @derberg
The text was updated successfully, but these errors were encountered: