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

[BUG] Different semantic information in output when using request/reply. (HTML vs Markdown) #594

Open
2 tasks done
FranzNBR opened this issue Aug 28, 2024 · 2 comments
Open
2 tasks done
Labels
bug Something isn't working

Comments

@FranzNBR
Copy link

Describe the bug.

AsyncAPI (3.0.0)

When using this template the output file contains reply information that differs semantically from the output of the html template

Markdown output

Request information

  • request should be done to channel: pong

That's somehow confusing, because pong is the channel i want to read the response from.
The given message suggest i should send my request to the pong channel, which is wrong.

This happens with send-operations.

receive-operations give this information:

reply should be done to channel: pong

Which makes more sense. (Although the HTML output is still more clear to me)

I want to add that I'm not entirely sure i understood the reply feature correctly. But according to Doc: Adding reply info and when inspecting the html output, i think it makes sense.

Expected behavior

The expected markdown output should match the HTML output in the context of reply information

HTML output:

REPLY CHANNEL INFORMATION
Reply will be provided via this designated address: pong

Because it tells me on which channel the response can be read from.

Screenshots

Files: files.zip

markdown-template
image

html-template
image

How to Reproduce

  1. create operation with "action: send" and "reply:.." using AsyncAPI 3.0.0
  2. generate markdown file with this template
  3. notice confusing reply-information

🥦 Browser

Mozilla Firefox

👀 Have you checked for similar open issues?

  • I checked and didn't find similar issue

🏢 Have you read the Contributing Guidelines?

Are you willing to work on this issue ?

No, someone else can work on it

@FranzNBR FranzNBR added the bug Something isn't working label Aug 28, 2024
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.

@derberg
Copy link
Member

derberg commented Sep 2, 2024

thanks, makes sense, are you willing to open a PR with the fix?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants