asyncapi / website

AsyncAPI specification website
https://www.asyncapi.com
Apache License 2.0
527 stars 669 forks source link

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

Open ababkin opened 3 months ago

ababkin commented 3 months ago

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

github-actions[bot] commented 3 months ago

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.