From 15ac5994ebf945f2cd79d57779787d2478e5177f Mon Sep 17 00:00:00 2001 From: Doug Davis Date: Sun, 25 Mar 2018 23:06:22 -0700 Subject: [PATCH] First pass at an 'extension attributes' doc Signed-off-by: Doug Davis --- Makefile | 2 +- extensions.md | 23 +++++++++++++++++++++++ spec.md | 2 ++ 3 files changed, 26 insertions(+), 1 deletion(-) create mode 100644 extensions.md diff --git a/Makefile b/Makefile index 4c9a627d8..0f5fb1ae5 100644 --- a/Makefile +++ b/Makefile @@ -5,4 +5,4 @@ verify: @# Use "-x" if you want to skip exernal links @tools/verify-links.sh -v . @echo Running the RFC2119 keyword checker: - @tools/verify-phrases.sh -v spec.md + @tools/verify-phrases.sh -v spec.md extensions.md diff --git a/extensions.md b/extensions.md new file mode 100644 index 000000000..ed70f3758 --- /dev/null +++ b/extensions.md @@ -0,0 +1,23 @@ +# CloudEvents Extension Attributes + +The [CloudEvents specification](spec.md) defines a set of metadata attributes +than can be used when tranforming a generic event into a CloudEvent. +The list of attributes specified in that document represent the minimal set +that the specification authors deemed most likely to be used in a majority of +situations. + +This document defines some addition attributes that, while not as commonly +used as the ones specified in the [CloudEvents specification](spec.md), +could still benefit from being formally specified in the hopes of providing +some degree of interoperabilty. This also allows for attributes to be +defined in an experimental manner and tested prior to being considered for +inclusion in the [CloudEvents specification](spec.md). + +Implementations of the [CloudEvents specification](spec.md) are not mandated +to limit their use of extension attributes to just the ones specified in +this document. The attributes defined in this document have no official +standing and might be changed, or removed, at any time. + +## Extension Attributes + +None at this time. diff --git a/spec.md b/spec.md index 6056065fa..2ffce3495 100644 --- a/spec.md +++ b/spec.md @@ -216,6 +216,8 @@ that contains both context and data). middleware might want to include and provides a place to test metadata before adding them to the CloudEvents specification. TBD - Determine a shorter prefix for this (e.g. OpenAPI uses “x-”) + See the [Extensions](extensions.md) document for a list of possible + properties. * Constraints: * OPTIONAL * If present, MUST contain at least one entry