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: operation trait object description #1001

Merged

Conversation

akkshitgupta
Copy link
Contributor

@akkshitgupta akkshitgupta commented Dec 6, 2023


title: "FIX: operation trait object description"


Related issue(s): fixes: #994

Earlier Now
the description didn't exclude the messages field as operation trait object doesn't have messages field like action or channel. the exclusion list includes the messages field as well along with others.
Earlier Updated

Add the ✏️ Editorial label.

NOTE: I found a number of MarkDown linting errors. Just want to confirm is it fine to Push the refactored changes in the same Pull Request or open a New Pull Request.

Always make sure that the specification markdown file has no markdown-related errors.

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide 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.

@akkshitgupta akkshitgupta changed the title fix: Operation Trait object description fix: operation trait object description Dec 6, 2023
@akkshitgupta
Copy link
Contributor Author

hey @akshatnema @smoya it would be great id you review the pull request for any changes or anything

@smoya
Copy link
Member

smoya commented Dec 11, 2023

NOTE: I found a number of MarkDown linting errors. Just want to confirm is it fine to Push the refactored changes in the same Pull Request or open a New Pull Request.

I would recommend you do it better in a new PR

@akkshitgupta
Copy link
Contributor Author

sure @smoya I will raise a new PR by improving the MarkDown linting as per the standards once this gets merged to avoid any conflicts

@smoya smoya added the 🤷‍♀️ Ambiguity An issue/PR which identifies or fixes spec ambiguity label Dec 15, 2023
@smoya
Copy link
Member

smoya commented Dec 15, 2023

@akshatnema please change the title prefix to docs: so we do not release a new fix but rather we consider this as an ambiguity in docs. The JSON Schema docs are not changing either.

@akkshitgupta akkshitgupta changed the title fix: operation trait object description docs: operation trait object description Dec 15, 2023
Copy link
Member

@smoya smoya left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! 🚀🌔

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.

LGTM

I will every PR has such a good and clear description, showing state before and after applying PR. Such a speed up for maintainer to do a review ❤️

Copy link

Quality Gate Passed Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

@smoya
Copy link
Member

smoya commented Feb 5, 2024

/rtm

@asyncapi-bot asyncapi-bot merged commit 083304d into asyncapi:master Feb 5, 2024
7 of 8 checks passed
@smoya
Copy link
Member

smoya commented Feb 8, 2024

@all-contributors please add @akkshitgupta for content,doc

Copy link
Contributor

@smoya

I've put up a pull request to add @akkshitgupta! 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🤷‍♀️ Ambiguity An issue/PR which identifies or fixes spec ambiguity ready-to-merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Fix description of Operation Trait object
4 participants