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

Provide config to show channel addresses as operation names in the sidebar for AsyncAPI v3 documents #1018

Closed
diegotorresd opened this issue Jun 24, 2024 · 1 comment · Fixed by #1022

Comments

@diegotorresd
Copy link
Contributor

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:

image

Output when rendering a v3 document:

image

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
Labels
None yet
Projects
None yet
1 participant