asyncapi-react icon indicating copy to clipboard operation
asyncapi-react copied to clipboard

Do not show reply address when empty

Open charbonnierg opened this issue 11 months ago • 1 comments

Description

I'm mainly using NATS as a message broker, which offers request/reply on dynamic addresses which are not indicated in the message payload or message header.

Thus, when documenting my applications with Async API, I use reply channels with empty address field.

However, the asyncapi-react component still displays:

Reply will be directed to the address specified at this location:

Alternatives

Maybe display a message like:

"Reply will be directed to an address according to client and server configurations"

This would be True with NATS, because client can choose the reply subject when sending a request, but I'm not sure it is more informational than simply removing the message.

Reasons

  • The current display is misleading, because there is no reply location at all, but the message still mention a reply location
  • The current display strongly looks like a checkbox and this can be disturbing for new users

Attachments

Here is the current output:

image

Here is the output on my fork:

image

Code changes can be found here

charbonnierg avatar Mar 06 '24 16:03 charbonnierg

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.

github-actions[bot] avatar Mar 06 '24 16:03 github-actions[bot]

This issue has been automatically marked as stale because it has not had recent activity :sleeping:

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience :heart:

github-actions[bot] avatar Jul 05 '24 00:07 github-actions[bot]

The current display strongly looks like a checkbox and this can be disturbing for new users

@charbonnierg, it looks like a checkbox cuz it was empty, which according to your suggestion, shouldn't be there in the first place if it's empty 👍🏾

AceTheCreator avatar Aug 12 '24 15:08 AceTheCreator

:tada: This issue has been resolved in version 2.2.1 :tada:

The release is available on:

Your semantic-release bot :package::rocket:

asyncapi-bot avatar Aug 21 '24 19:08 asyncapi-bot