CDEvents Primer - Draft
Abstract
This non-normative document provides an overview of the CDEvents specification. It is meant to complement the CDEvents specification to provide additional background and insight into the history and design decisions made during the development of the specification. This allows the specification itself to focus on the normative technical details.
Table of Contents
History
TBD
Relations to CloudEvents
CDEvents defines a specification 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
attribute and provide the corresponding JSON object through the
data
attribute.
CDEvents aims to use existing CloudEvents extension attributes (e.g.
partitionkey from the
Partitioning
extension) before defining its own extensions. When no appropriate extension
attributes exists, CDEvents aims to make an official CloudEvents extension for
the CloudEvents specification and listed with other documented
extensions.
Acknowledgments
The initial structure of the CDEvents specification format was based on the specification of the CloudEvents project.