AsyncAPI with CloudEvents #1349
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Adding a first draft according to cloudevents#1276 Signed-off-by: Lazzaretti <fabrizio@lazzaretti.me>
duglin
reviewed
May 27, 2025
| @@ -0,0 +1,32 @@ | |||
| # AsyncAPI With CloudEvents | |||
There was a problem hiding this comment.
Can you wrap the lines at 80 chars to align with our other docs?
duglin
reviewed
May 27, 2025
| # AsyncAPI With CloudEvents | ||
|
|
||
| This document describes how CloudEvents can be defined in [AsyncAPI v3](https://www.asyncapi.com/docs/reference/specification/v3.0.0). | ||
| It was created as a follow-up after discussion [cloudevents/spec#1276](https://github.com/cloudevents/spec/issues/1276). |
There was a problem hiding this comment.
We can remove this line since once the PR is merged people shouldn't need to see the history to understand what's going on. Or, if there's important info in the issue then let's bring it into this doc.
duglin
reviewed
May 27, 2025
| Asynchronous APIs, e.g., events, can be specified in AsyncAPI, similar to how RESTful APIs can be specified in [OpenAPI](https://swagger.io/specification/). | ||
| When defining new events in an API-first approach it can be hard to add CloudEvents headers or fields according to spec. | ||
| This makes following the standard harder. | ||
| This document should clarify how CloudEvents headers can be specified in AsyncAPI. |
|
CI failed with: you should be able to clone an existing he/CN template files and just change the href in there. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Working draft for #1276
Clarify how CloudEvents headers can be specified in AsyncAPI.
Proposed Changes
Release Note
Open points
$ref:in cloudevents/working-drafts/asyncapi-examples/light-switch-events-binary-kafka.yaml to trait before merging. The current version is better to test the API spec. Afterwards, it should point to the main branch of the cloudevents/spec repo.