search

asyncapi / markdown-template

Markdown template for the AsyncAPI Generator
27 stars 34 forks source link

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

Open FranzNBR opened 2 months ago

FranzNBR commented 2 months ago

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?

🏢 Have you read the Contributing Guidelines?

Are you willing to work on this issue ?

No, someone else can work on it

github-actions[bot] commented 2 months ago

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 commented 2 months ago

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