markdown-template icon indicating copy to clipboard operation
markdown-template copied to clipboard

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

Open FranzNBR opened this issue 1 year ago • 2 comments

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?

  • [X] 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 avatar Aug 28 '24 08:08 FranzNBR

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 Aug 28 '24 08:08 github-actions[bot]

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

derberg avatar Sep 02 '24 14:09 derberg

If no one is working on this issue, may I work on this?

SykoDaedalus avatar Jan 13 '25 13:01 SykoDaedalus

sure thing

derberg avatar Jan 13 '25 14:01 derberg

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

The release is available on:

Your semantic-release bot :package::rocket:

asyncapi-bot avatar Feb 13 '25 15:02 asyncapi-bot