You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We recently migrated from AsyncAPI v2 to v3.
For AsyncAPI v2.6.0 documents, the sidebar component provides a fallback that uses the channel's address as an operation name in the sidebar, if a summary property is not provided. We were relying on this behaviour to have a convenient list of all the topics in the sidebar.
After the switch to v3, we have no way to show the channels on the sidebar, which makes it inconvenient for the users of our documentation.
We would like to add a configuration flag that triggers the behaviour to use the channel name also for v3 documents.
I am willing to open a PR to implement this.
Reasons
To maintain consistent UX when rendering both AsyncAPI v2 and v3 documents.
Attachments
Output when rendering a v2 document:
Output when rendering a v3 document:
The text was updated successfully, but these errors were encountered:
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.
Description
We recently migrated from AsyncAPI v2 to v3.
For AsyncAPI v2.6.0 documents, the sidebar component provides a fallback that uses the channel's address as an operation name in the sidebar, if a
summary
property is not provided. We were relying on this behaviour to have a convenient list of all the topics in the sidebar.After the switch to v3, we have no way to show the channels on the sidebar, which makes it inconvenient for the users of our documentation.
We would like to add a configuration flag that triggers the behaviour to use the channel name also for v3 documents.
I am willing to open a PR to implement this.
Reasons
To maintain consistent UX when rendering both AsyncAPI v2 and v3 documents.
Attachments
Output when rendering a v2 document:
Output when rendering a v3 document:
The text was updated successfully, but these errors were encountered: