feat: add configuration to use channel addresses in the sidebar for AsyncAPI v3 #1022
Conversation
diegotorresd
requested review from
magicmatatjahu,
derberg,
fmvilas and
asyncapi-bot-eve
as code owners
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide 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.
diegotorresd
changed the title
diegotorresd
changed the title
diegotorresd
force-pushed
the
use-channel-address-in-sidebar-for-v3
branch
from
9add575 to
2d9d622
Compare
|
|
LGTM Thanks for your contribution @diegotorresd |
| `useChannelAddressAsIdentifier` uses the channel address or operation summary in the sidebar instead of the operationId, for both AsyncAPI v2 and v3 documents. | ||
| The default behaviour is to do this only for v2 documents. |
There was a problem hiding this comment.
| `useChannelAddressAsIdentifier` uses the channel address or operation summary in the sidebar instead of the operationId, for both AsyncAPI v2 and v3 documents. | |
| The default behaviour is to do this only for v2 documents. | |
| `useChannelAddressAsIdentifier` for AsyncAPI v3 documents, use the operation summary or channel address in the sidebar instead of the operationId. By default, this behavior is applied only to AsyncAPI v2 documents.. |
small suggestion for docs, the rest is great, so just please apply this suggestion and we can merge
|
|
/rtm |
|
🎉 This PR is included in version 2.2.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Description
Changes proposed in this pull request:
useChannelAddressAsIdentifierto the sidebar configuration, so that the channel address is used as a fallback also for AsyncAPI v3 documents. This helps maintain consistent UI when migrating from V2 to V3.Related issue(s)
Fixes #1018