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

docs: added content for operations in AsyncAPI Document #2171

Closed
wants to merge 27 commits into from
Closed

docs: added content for operations in AsyncAPI Document #2171

wants to merge 27 commits into from

Conversation

BhaswatiRoy
Copy link
Collaborator

@BhaswatiRoy BhaswatiRoy commented Sep 26, 2023

Fix: #1512

Content:

Meaning of operations
Steps for adding operations
Types of operations
Work: GSoD 2023 Issue

Continuation: #1777

@netlify
Copy link

netlify bot commented Sep 26, 2023

Deploy Preview for shimmering-choux-eb0798 ready!

Name Link
🔨 Latest commit 436b618
🔍 Latest deploy log https://app.netlify.com/sites/shimmering-choux-eb0798/deploys/654a3f11f3e41b0008649fea
😎 Deploy Preview https://deploy-preview-2171--shimmering-choux-eb0798.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Collaborator

@TRohit20 TRohit20 left a 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.

Copy link
Member

@derberg derberg left a 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'

@BhaswatiRoy
Copy link
Collaborator Author

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.

@BhaswatiRoy BhaswatiRoy requested a review from derberg October 30, 2023 05:20
@BhaswatiRoy
Copy link
Collaborator Author

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.

Copy link
Collaborator

@TRohit20 TRohit20 left a 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.

@BhaswatiRoy
Copy link
Collaborator Author

Left couple of suggestions, please update as you see fit.

Thanks for the review, updated the suggestions!

@BhaswatiRoy BhaswatiRoy requested a review from derberg November 26, 2023 06:02
@derberg derberg deleted the branch asyncapi:next-major-spec December 5, 2023 09:40
@derberg derberg closed this Dec 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants