Skip to content
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

[Docs Bug 🐞 report]: operation object example incorrect #3177

Open
1 task done
ababkin opened this issue Aug 31, 2024 · 1 comment
Open
1 task done

[Docs Bug 🐞 report]: operation object example incorrect #3177

ababkin opened this issue Aug 31, 2024 · 1 comment

Comments

@ababkin
Copy link

ababkin commented Aug 31, 2024

Describe the bug you found in AsyncAPI Docs.

it specifically says:
"It MUST contain a subset of the messages defined in the channel referenced in this operation, and MUST NOT point to a subset of message definitions located in the Messages Object in the Components Object or anywhere else."

but then the example later reads:

messages:
  - $ref: '#/components/messages/userSignedUp'

this example breaks and is fixed if i follow the original suggestion to reference from the channel messages and not from component messages

Attach any resources that can help us understand the issue.

https://www.asyncapi.com/docs/reference/specification/v3.0.0#channelsObject

Code of Conduct

  • I agree to follow this project's Code of Conduct
Copy link

Welcome to AsyncAPI. Thanks a lot for reporting your first issue. Please check out our contributors guide and the instructions about a basic recommended setup useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant