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

Add definition for Operation to spec 3.0 #993

Open
buehlefs opened this issue Nov 17, 2023 · 5 comments
Open

Add definition for Operation to spec 3.0 #993

buehlefs opened this issue Nov 17, 2023 · 5 comments
Labels
stale 💭 Strawman (RFC 0) RFC Stage 0 (See CONTRIBUTING.md)

Comments

@buehlefs
Copy link

Since version 3 elevates operations to a top level component (and spec v3 Operations have a different semantic compared to 2.x) they should have a dedicated definition in the definitions section. (Additionally, operations could also be added to the concepts)

I do not have a fleshed out proposal yet (I may create a PR if I find the time to do so), so feel free to propose a definition or create a PR.

Suggested starting point:

An operation describes a specific action an application can take to interact with the async api.
Operations are performed by sending (or receiving) messages to (or from) channels.

Related Issues:

@buehlefs buehlefs added the 💭 Strawman (RFC 0) RFC Stage 0 (See CONTRIBUTING.md) label Nov 17, 2023
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.

@derberg
Copy link
Member

derberg commented Nov 21, 2023

Hey, yes, you're right, we need it. I think your text is ok.

@smoya @fmvilas @char0n @dalelane thoughts?

@char0n
Copy link
Collaborator

char0n commented Nov 22, 2023

Yes, good idea

@buehlefs Operation description is good start and is using working already present in AsyncAPI 3.0.0 spec.

An operation describes a specific action an application can take to interact with the async api.
Operations are performed by sending (or receiving) messages to (or from) channels.

There is a mention of async api - we have to address this as it's a bit ambiguous and is not clear what does it actually mean.
I would suggest the following change which is compatible with the existing AsyncAPI 3.0.0 wording:

An operation describes a specific action an application can take to interact with the message-driven APIs.
Operations are performed by sending (or receiving) messages to (or from) channels.

Copy link

This issue has been automatically marked as stale because it has not had recent activity 😴

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience ❤️

@github-actions github-actions bot added the stale label Mar 22, 2024
@smoya smoya removed the stale label Mar 22, 2024
Copy link

This issue has been automatically marked as stale because it has not had recent activity 😴

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience ❤️

@github-actions github-actions bot added the stale label Jul 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
stale 💭 Strawman (RFC 0) RFC Stage 0 (See CONTRIBUTING.md)
Projects
None yet
Development

No branches or pull requests

4 participants