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.

Sign up for GitHub

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

Explain relations to CloudEvents #19

Merged
merged 2 commits into from
Jan 26, 2022
Merged

Explain relations to CloudEvents #19

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1ede84d
Explain relations to CloudEvents
m-linner-ericsson Jan 26, 2022
bea4bbe
Fix review comments
m-linner-ericsson Jan 26, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions primer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,34 @@ This non-normative document provides an overview of the CDEvents specification.

<!-- toc -->
- [History](#history)
- [Relations to CloudEvents](#relations-to-cloudevents)
- [Acknowledgments](#acknowledgments)
<!-- /toc -->

## History

TBD

## Relations to CloudEvents

CDEvents defines a [specification](./cloudevents-binding.md) that provides a set
of JSON object schemas (one for each event type, covering mandatory and optional
attributes etc.)

When used with CloudEvents, CDEvents passes the JSON schema via the
[`dataschema`](https://github.com/cloudevents/spec/blob/v1.0.1/spec.md#dataschema)
attribute and provide the corresponding JSON object through the
[`data`](https://github.com/cloudevents/spec/blob/v1.0.1/spec.md#event-data)
attribute.

CDEvents aims to use existing CloudEvents extension attributes (e.g.
`partitionkey` from the
[Partitioning](https://github.com/cloudevents/spec/blob/v1.0.1/extensions/partitioning.md)
extension) before defining its own extensions. When no appropriate extension
afrittoli marked this conversation as resolved.
Show resolved Hide resolved
attributes exists, CDEvents aims to make an official CloudEvents extension for
the CloudEvents specification and listed with other [documented
extensions](https://github.com/cloudevents/spec/blob/v1.0.1/documented-extensions.md).

## Acknowledgments

The initial structure of the CDEvents specification format was based on the specification of the [CloudEvents](https://github.com/cloudevents/spec) project.