Skip to content

About

The common Event Envelopes (CloudEvents) vocabulary, distilled from providers' own OpenAPI: shared operations, JSON Schema with measured adoption, per-provider crosswalks.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

1 Commit

Folders and files

Event Envelopes (CloudEvents)

How an event is described as it moves between systems -- its id, source, type, time and spec version around the event's own data. The envelope is owned by the CNCF CloudEvents specification, so this context publishes CloudEvents' own attributes and measures which providers' webhooks and event APIs carry them.

A reference context. The shape belongs to cloudevents-1.0 (Apache-2.0). This repository does not restate or rename it: schema/ holds the standard's own objects, each linked to the release it was read from, and crosswalk/ measures, from each provider's harvested OpenAPI, which operations it implements and what share of the standard's request and response fields it carries.

Measured across 858 providers tagged Webhooks, Event Streaming, Event-Driven, Streaming, Message Queue, Pub/Sub, Real-Time, Serverless, Workflow Automation, Integration Platform, iPaaS, Observability, Cloud-Native in APIs.io: 3 implement the standard; 16 name it somewhere in a spec.

The standard's APIs

API Release Implementers Operations

Implementers

Coverage is the best-matching operation's share of the standard's fields, per API.

Provider APIs (field coverage)
apache-event-mesh objects 100%
azure-event-grid objects 90%
datacrunch objects 70%

Findings

  • Three providers publish a schema carrying the CloudEvents envelope, specversion included, out of 858 webhook, event-streaming and integration providers measured: apache-event-mesh and azure-event-grid (90-100% of the attributes) and datacrunch, whose audit-log events are CloudEvents-shaped (70%).
  • Sixteen providers name CloudEvents or specversion somewhere in a spec. The gap is expected for this standard: in its HTTP binary mode the attributes travel as ce- headers, which a schema does not show.

Decisions

  • A schema matches only if it carries specversion, the one attribute no other event shape uses; id, source, type, time and data alone describe most events.
  • The webhooks context's event shape stays as measured; this context is where it meets the standard.

Licence

Measurements (profile, crosswalks, adopters) are CC BY-NC-SA 4.0; code is Apache 2.0. The standard's objects in schema/ remain under the standard's own licence (Apache-2.0).

About

The common Event Envelopes (CloudEvents) vocabulary, distilled from providers' own OpenAPI: shared operations, JSON Schema with measured adoption, per-provider crosswalks.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors