Skip to content

Commit

Permalink
Links
Browse files Browse the repository at this point in the history
Profile based on `1.0.1` of CE spec
  • Loading branch information
sanderke committed Jul 15, 2024
1 parent 73ec861 commit 40368e4
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 17 deletions.
6 changes: 3 additions & 3 deletions Appendix-1.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
22 changes: 11 additions & 11 deletions Context Attributes.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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**

Expand All @@ -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

Expand Down Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion Notations and Terminology.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
4 changes: 2 additions & 2 deletions Overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.


0 comments on commit 40368e4

Please sign in to comment.