From 40368e40b46797ca06dbfe32ba44cdbd24994a63 Mon Sep 17 00:00:00 2001 From: Alexander Green Date: Mon, 15 Jul 2024 15:12:24 +0200 Subject: [PATCH] Links Profile based on `1.0.1` of CE spec --- Appendix-1.md | 6 +++--- Context Attributes.md | 22 +++++++++++----------- Notations and Terminology.md | 2 +- Overview.md | 4 ++-- 4 files changed, 17 insertions(+), 17 deletions(-) diff --git a/Appendix-1.md b/Appendix-1.md index fca9306..55435d4 100644 --- a/Appendix-1.md +++ b/Appendix-1.md @@ -15,6 +15,6 @@ about the use of the specifications within the context of the Dutch government. For the time being, the following constraints apply: -- One SHOULD use the [JSON Event Format for CloudEvents](https://github.com/cloudevents/spec/blob/v1.0.2/json-format.md) specification and pay attention to the points of attention and recommendations in the guideline [NL GOV Guideline for CloudEvents JSON](https://gitdocumentatie.logius.nl/publicatie/notificatieservices/guidelines/#guideline-for-the-use-of-the-json-event-format-for-cloudevents). -- One SHOULD use the [HTTP Protocol Binding for CloudEvents](https://github.com/cloudevents/spec/blob/v1.0.2/http-protocol-binding.md) specification and pay attention to the points of attention and recommendations in the guideline [NL GOV Guideline for CloudEvents HTTP](https://gitdocumentatie.logius.nl/publicatie/notificatieservices/guidelines/#guideline-for-the-use-of-the-http-protocol-binding-for-cloudevents). -- One SHOULD use the [HTTP 1.1 Web Hooks for Event Delivery](https://github.com/cloudevents/spec/blob/v1.0.2/http-webhook.md) specification and pay attention to the points of attention and recommendations in the guideline [NL GOV Guideline for CloudEvents Webhook](https://gitdocumentatie.logius.nl/publicatie/notificatieservices/guidelines/#guideline-for-the-use-of-the-webhook-pattern-for-cloudevents). +- One SHOULD use the [JSON Event Format for CloudEvents](https://github.com/cloudevents/spec/blob/v1.0.1/json-format.md) specification and pay attention to the points of attention and recommendations in the guideline [NL GOV Guideline for CloudEvents JSON](https://gitdocumentatie.logius.nl/publicatie/notificatieservices/guidelines/#guideline-for-the-use-of-the-json-event-format-for-cloudevents). +- One SHOULD use the [HTTP Protocol Binding for CloudEvents](https://github.com/cloudevents/spec/blob/v1.0.1/http-protocol-binding.md) specification and pay attention to the points of attention and recommendations in the guideline [NL GOV Guideline for CloudEvents HTTP](https://gitdocumentatie.logius.nl/publicatie/notificatieservices/guidelines/#guideline-for-the-use-of-the-http-protocol-binding-for-cloudevents). +- One SHOULD use the [HTTP 1.1 Web Hooks for Event Delivery](https://github.com/cloudevents/spec/blob/v1.0.1/http-webhook.md) specification and pay attention to the points of attention and recommendations in the guideline [NL GOV Guideline for CloudEvents Webhook](https://gitdocumentatie.logius.nl/publicatie/notificatieservices/guidelines/#guideline-for-the-use-of-the-webhook-pattern-for-cloudevents). diff --git a/Context Attributes.md b/Context Attributes.md index 3ba8b38..3fcbf7d 100644 --- a/Context Attributes.md +++ b/Context Attributes.md @@ -210,7 +210,7 @@ The following attributes are REQUIRED to be present in all CloudEvents: routing, observability, policy enforcement, etc. The format of this is producer defined and might include information such as the version of the `type` - see - [Versioning of CloudEvents in the Primer](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/primer.md#versioning-of-cloudevents) + [Versioning of CloudEvents in the Primer](https://github.com/cloudevents/spec/blob/v1.0.1/cloudevents/primer.md#versioning-of-cloudevents) for more information. - Constraints: - REQUIRED @@ -257,12 +257,12 @@ on the definition of OPTIONAL. - Description: Content type of `data` value. This attribute enables `data` to carry any type of content, whereby format and encoding might differ from that of the chosen event format. For example, an event rendered using the - [JSON envelope](https://github.com/cloudevents/spec/blob/v1.0.2/json-format.md#3-envelope) format might carry an XML payload + [JSON envelope](https://github.com/cloudevents/spec/blob/v1.0.1/json-format.md#3-envelope) format might carry an XML payload in `data`, and the consumer is informed by this attribute being set to "application/xml". The rules for how `data` content is rendered for different `datacontenttype` values are defined in the event format specifications; for example, the JSON event format defines the relationship in - [section 3.1](https://github.com/cloudevents/spec/blob/v1.0.2/json-format.md#31-handling-of-data). + [section 3.1](https://github.com/cloudevents/spec/blob/v1.0.1/json-format.md#31-handling-of-data). For some binary mode protocol bindings, this field is directly mapped to the respective protocol's content-type metadata property. Normative rules for the @@ -299,7 +299,7 @@ preferred to use for payload data). - Type: `URI` - Description: Identifies the schema that `data` adheres to. Incompatible changes to the schema SHOULD be reflected by a different URI. See - [Versioning of CloudEvents in the Primer](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/primer.md#versioning-of-cloudevents) + [Versioning of CloudEvents in the Primer](https://github.com/cloudevents/spec/blob/v1.0.1/cloudevents/primer.md#versioning-of-cloudevents) for more information. - Constraints: - OPTIONAL @@ -341,8 +341,8 @@ Constraints: created" event, and the `id` uniquely identifies the event instance to distinguish separate occurrences of a same-named blob having been created; the name of the newly created blob is carried in `subject`: - - `source`: https://example.com/storage/tenant/container - - `subject`: mynewfile.jpg + - `source: https://example.com/storage/tenant/container` + - `subject: mynewfile.jpg` **CloudEvents-NL** @@ -351,9 +351,9 @@ Constraints: To be determined partly on the basis of future agreements about subscription and filtering. Example: - - `source`: urn:nld:oin:00000001823288444000:systeem:BRP-component - - `type`: nl.brp.persoon-gehuwd - - `subject`: 999990342 (citizen service number) + - `source: urn:nld:oin:00000001823288444000:systeem:BRP-component` + - `type: nl.brp.persoon-gehuwd` + - `subject: 999990342` (citizen service number) ## time @@ -396,14 +396,14 @@ messages if the copied values differ from the cloud-event serialized values. ## Defining Extensions -See [CloudEvent Attributes Extensions](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/primer.md#cloudevent-attribute-extensions) +See [CloudEvent Attributes Extensions](https://github.com/cloudevents/spec/blob/v1.0.1/cloudevents/primer.md#cloudevent-attribute-extensions) for additional information concerning the use and definition of extensions. The definition of an extension SHOULD fully define all aspects of the attribute - e.g. its name, type, semantic meaning and possible values. New extension definitions SHOULD use a name that is descriptive enough to reduce the chances of name collisions with other extensions. In particular, extension -authors SHOULD check the [documented extensions](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/documented-extensions.md) +authors SHOULD check the [documented extensions](https://github.com/cloudevents/spec/blob/v1.0.1/cloudevents/documented-extensions.md) document for the set of known extensions - not just for possible name conflicts but for extensions that might be of interest. diff --git a/Notations and Terminology.md b/Notations and Terminology.md index 78bf886..d9ac77e 100644 --- a/Notations and Terminology.md +++ b/Notations and Terminology.md @@ -79,7 +79,7 @@ information. #### Event Format An Event Format specifies how to serialize a CloudEvent as a sequence of bytes. -Stand-alone event formats, such as the [JSON format](https://github.com/cloudevents/spec/blob/v1.0.2/json-format.md), specify +Stand-alone event formats, such as the [JSON format](https://github.com/cloudevents/spec/blob/v1.0.1/json-format.md), specify serialization independent of any protocol or storage medium. Protocol Bindings MAY define formats that are dependent on the protocol. diff --git a/Overview.md b/Overview.md index 8a22a95..bfa21fa 100644 --- a/Overview.md +++ b/Overview.md @@ -15,9 +15,9 @@ provide interoperability across services, platforms and systems. Event Formats specify how to serialize a CloudEvent with certain encoding formats. Compliant CloudEvents implementations that support those encodings MUST adhere to the encoding rules specified in the respective event format. All -implementations MUST support the [JSON format](https://github.com/cloudevents/spec/blob/v1.0.2/json-format.md). +implementations MUST support the [JSON format](https://github.com/cloudevents/spec/blob/v1.0.1/json-format.md). For more information on the history, development and design rationale behind the -specification, see the [CloudEvents Primer](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/primer.md) document. +specification, see the [CloudEvents Primer](https://github.com/cloudevents/spec/blob/v1.0.1/cloudevents/primer.md) document.