-
-
Notifications
You must be signed in to change notification settings - Fork 681
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
docs: added content for operations in AsyncAPI Document #2171
Conversation
✅ Deploy Preview for shimmering-choux-eb0798 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Use backticks wherever required throughout the document.
Co-authored-by: Rohit <[email protected]>
Co-authored-by: Rohit <[email protected]>
Co-authored-by: Rohit <[email protected]>
Co-authored-by: Rohit <[email protected]>
Co-authored-by: Rohit <[email protected]>
Co-authored-by: Rohit <[email protected]>
Co-authored-by: Rohit <[email protected]>
Co-authored-by: Rohit <[email protected]>
Co-authored-by: Rohit <[email protected]>
Co-authored-by: Rohit <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like the intro and features a lot, well explained, but for the rest I stopped review as you need to go through it again and make sure it is really about v3, because operations
are no longer under channels
in v3, these are separate objects in AsyncAPI document, on the same level, on root. And you link them by referencing inside operation what channel it relates to
https://www.asyncapi.com/docs/reference/specification/v3.0.0-next-major-spec.14#operationsObject
onUserSignUp:
title: User sign up
summary: Action to sign a user up.
description: A longer description
channel:
$ref: '#/channels/userSignup'
Hello @derberg I have updated the contents as per your technical review, please let me know if you want me to update any thing more. |
Co-authored-by: Lukasz Gornicki <[email protected]>
Co-authored-by: Lukasz Gornicki <[email protected]>
…into gsod-work-1
Thanks @derberg for the re-review, I have updated all the changes as per your comments. Do let me know if I still missed anything and need to add/remove anything. |
Co-authored-by: Lukasz Gornicki <[email protected]>
Co-authored-by: Lukasz Gornicki <[email protected]>
this line was supposed to be removed from the old draft but for some reason, it still wasn't removed when I pushed the changes to github.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Left couple of suggestions, please update as you see fit.
Co-authored-by: Rohit <[email protected]>
Co-authored-by: Rohit <[email protected]>
Thanks for the review, updated the suggestions! |
Fix: #1512
Content:
Meaning of operations
Steps for adding operations
Types of operations
Work: GSoD 2023 Issue
Continuation: #1777