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

Generete reply information #452

Closed
CodeGlitcher opened this issue Jan 22, 2024 · 4 comments
Closed

Generete reply information #452

CodeGlitcher opened this issue Jan 22, 2024 · 4 comments
Labels
enhancement New feature or request

Comments

@CodeGlitcher
Copy link

Reason/Context

Please try answering few of those questions

  • Why we need this improvement?
    De asyncapi 3.0 spec allows for message reply to be defined. Generated documentation should reflect this.
  • How will this change help?
  • What is the motivation?
    Other team members can easily see how this api works and what data they should expect.

When operation specifies a reply.
I expect that the generated markdown include this.
I think the generator should add a reply header with the detail of the reply.

Description

Please try answering few of those questions

  • What changes have to be introduced?

  • Will this be a breaking change?
    Not sure

  • How could it be implemented/designed?
    I think a Replay block with details should keep thing readable.

Reply

Reply table / details

Added my test input and current output:
current-output.md
input.yaml.txt

@CodeGlitcher CodeGlitcher added the enhancement New feature or request label Jan 22, 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.

@korifey91
Copy link
Contributor

I'm facing the same issue. In my spec file I have reply message and I need to see what message will be sent as a reply.

image

@derberg
Copy link
Member

derberg commented Apr 8, 2024

@CodeGlitcher please join review -> #523

@derberg
Copy link
Member

derberg commented Apr 18, 2024

solved with #523

@derberg derberg closed this as completed Apr 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants