Skip to content

Commit c26a694

Browse files
duglinduglin
authored
Merge pull request #1362 from duglin/fixup
Fixup for new process & support shortened release names
2 parents 8c9d74b + 575ddd1 commit c26a694

File tree

31 files changed

+161
-146
lines changed

31 files changed

+161
-146
lines changed

‎README.md‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,12 +56,19 @@ and a graduated project on [Jan 25, 2024](https://github.com/cncf/toc/pull/996)
5656
| [Documented Extensions](cloudevents/extensions/README.md) | - | [Not versioned](cloudevents/extensions/README.md) |
5757
| [Proprietary Specifications](cloudevents/proprietary-specs.md) | - | [Not versioned](cloudevents/proprietary-specs.md) |
5858

59+
The most recent release of the CloudEvents specifications can be found
60+
via the [ce@stable](https://github.com/cloudevents/spec/blob/ce@stable) tag.
61+
5962
## Other Specifications
6063
| | Latest Release | Working Draft |
6164
| :-------------- | :-------------------------------------------------------------: | :---------------------------: |
6265
| CE SQL | [v1.0.0](https://github.com/cloudevents/spec/tree/cesql@v1.0.0) | [WIP](cesql/spec.md) |
6366
| Subscriptions | - | [WIP](subscriptions/spec.md) |
6467

68+
The most recent release of the CESQL specification can be found
69+
via the [cesql@stable](https://github.com/cloudevents/spec/blob/cesql@stable)
70+
tag.
71+
6572
The Registry and Pagination specifications can now be found in the
6673
[xRegistry/spec](https://github.com/xregistry/spec) repo.
6774

@@ -167,7 +174,7 @@ Please see the
167174
[meeting minutes doc](https://docs.google.com/document/d/1OVF68rpuPK5shIHILK9JOqlZBbfe91RNzQ7u_P7YCDE/edit#)
168175
for the latest information on how to join the calls.
169176

170-
Recording from our calls are available
177+
Recording from our calls are available
171178
[here](https://www.youtube.com/playlist?list=PLO-qzjSpLN1BEyKjOVX_nMg7ziHXUYwec), and
172179
older ones are
173180
[here](https://www.youtube.com/playlist?list=PLj6h78yzYM2Ph7YoBIgsZNW_RGJvNlFOt).

‎cesql/languages/zh-CN/translations.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Translation list of the cesql spec
1+
# Translation list of the cesql spec
22

33
| Documents | Status | Last edited | Version |
44
| :--------- | :---------: | :--------- | :---------: |

‎cloudevents/adapters/aws-sns.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This document describes how to convert [AWS SNS messages][sns-messages] into CloudEvents.
44

5-
Amazon SNS MAY send a subscription confirmation, notification, or unsubscribe confirmation
5+
Amazon SNS MAY send a subscription confirmation, notification, or unsubscribe confirmation
66
message to your HTTP/HTTPS endpoints.
77

88
Each section below describes how to determine the CloudEvents attributes
@@ -50,4 +50,4 @@ based on the specified type of SNS messages.
5050
| `time` | "Timestamp" value |
5151
| `data` | HTTP payload |
5252

53-
[sns-messages]: https://docs.aws.amazon.com/sns/latest/dg/sns-message-and-json-formats.html
53+
[sns-messages]: https://docs.aws.amazon.com/sns/latest/dg/sns-message-and-json-formats.html

‎cloudevents/extensions/authcontext.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ described in [RFC 2119](https://tools.ietf.org/html/rfc2119).
1717

1818
However, the scope of these key words is limited to when this extension is
1919
used. For example, an attribute being marked as "REQUIRED" does not mean
20-
it needs to be in all CloudEvents, rather it needs to be included only when
20+
it needs to be in all CloudEvents, rather it needs to be included only when
2121
this extension is being used.
2222

2323
## Attributes

‎cloudevents/extensions/expirytime.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ described in [RFC 2119](https://tools.ietf.org/html/rfc2119).
2020

2121
However, the scope of these key words is limited to when this extension is
2222
used. For example, an attribute being marked as "REQUIRED" does not mean
23-
it needs to be in all CloudEvents, rather it needs to be included only when
23+
it needs to be in all CloudEvents, rather it needs to be included only when
2424
this extension is being used.
2525

2626
## Attributes

‎cloudevents/extensions/opcua.md‎

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -62,9 +62,9 @@ For metadata, event and data messages (type one of `ua-metadata`, `ua-keyframe`,
6262
Header](https://reference.opcfoundation.org/Core/Part14/v105/docs/7.2.5.4#Table164)
6363
field `DataSetWriterId` or `DataSetWriterName`.
6464

65-
For event messages (type equals to `ua-event`) `subject` MUST be appended with
65+
For event messages (type equals to `ua-event`) `subject` MUST be appended with
6666
"/" and [Base Event Type](https://reference.opcfoundation.org/Core/Part5/v104/docs/6.4.2)
67-
field `EventId`.
67+
field `EventId`.
6868

6969
### time
7070

@@ -104,7 +104,7 @@ determine the latency between event publisher towards consumer.
104104

105105
- Type: `Integer`
106106
- Description: Links dataset message to the current version of the metadata.
107-
Contains value from `MajorVersion` of [Data Set Message Header](https://reference.opcfoundation.org/Core/Part14/v105/docs/7.2.5.4#Table164) field `MetaDataVersion`.
107+
Contains value from `MajorVersion` of [Data Set Message Header](https://reference.opcfoundation.org/Core/Part14/v105/docs/7.2.5.4#Table164) field `MetaDataVersion`.
108108
- Constraints
109109
- OPTIONAL but MUST NOT be present if `dataschema` is used
110110

@@ -121,7 +121,7 @@ field `MetaDataVersion`.
121121
### opcuastatus
122122

123123
- Type: `Integer`
124-
- Description: Defines the overall status of the data set message, maps to
124+
- Description: Defines the overall status of the data set message, maps to
125125
[Data Set Message Header](https://reference.opcfoundation.org/Core/Part14/v105/docs/7.2.5.4#Table164) field `Status`.
126126
- Constraints
127127
- OPTIONAL
@@ -142,7 +142,7 @@ and Data Set Header as that information is mapped into CloudEvents attributes.
142142

143143
### Metadata message
144144

145-
The metadata message helps Cloud applications to understand the semantics and
145+
The metadata message helps Cloud applications to understand the semantics and
146146
structure of dataset messages.
147147

148148
```text
@@ -176,16 +176,16 @@ subject: energy-consumption-asset
176176
-----------------------------------------------
177177
```
178178

179-
### Telemetry message
179+
### Telemetry message
180180

181-
The telemetry or data messages contain values of all OPC UA nodes that had
182-
changed in a given period of time (`ua-deltaframe`) or contain values for all
183-
OPC UA nodes that were monitored (`ua-keyframe`).
184-
The complete list of monitored OPC UA nodes as well as the related type
185-
information are defined in the metadata message. The attributes
181+
The telemetry or data messages contain values of all OPC UA nodes that had
182+
changed in a given period of time (`ua-deltaframe`) or contain values for all
183+
OPC UA nodes that were monitored (`ua-keyframe`).
184+
The complete list of monitored OPC UA nodes as well as the related type
185+
information are defined in the metadata message. The attributes
186186
`opcuametadatamajorversion` and `opcuametadataminorversion` are used to
187-
reference the correct metadata message. The `ua-deltaframe` messages will be
188-
used for hot and/or cold path processing and `ua-keyframe` messages can
187+
reference the correct metadata message. The `ua-deltaframe` messages will be
188+
used for hot and/or cold path processing and `ua-keyframe` messages can
189189
additional be used to update last-known-value tables.
190190

191191

@@ -214,7 +214,7 @@ opcuametadataminorversion: 672341762
214214
------------------ payload -------------------
215215
216216
{
217-
... application data
217+
... application data
218218
(OPC UA PubSub JSON single dataset Message)...
219219
}
220220
@@ -223,9 +223,9 @@ opcuametadataminorversion: 672341762
223223

224224
#### OPC UA PubSub JSON single dataset Message
225225

226-
Using CloudEvents and model the OPC UA PubSub header information as CloudEvent
227-
attributes enables integration into various system (independent from used
228-
protocols) and simplifies the payload structure.
226+
Using CloudEvents and model the OPC UA PubSub header information as CloudEvent
227+
attributes enables integration into various system (independent from used
228+
protocols) and simplifies the payload structure.
229229

230230
```text
231231
{
@@ -256,11 +256,11 @@ protocols) and simplifies the payload structure.
256256
### Event message
257257

258258
The event message will contain a single event and the identifier of this event is
259-
added to the `subject` to allow routing it into different systems without parsing
260-
the payload. Events are routed for example in systems like Manufacturing Execution
261-
Systems (MES), Supervisory Control and Data Acquisition systems (SCADA),
262-
Alerting Systems or Operation Technology Operator Terminals (HMI Clients) and
263-
also in hot and/or cold path processing. The attributes
259+
added to the `subject` to allow routing it into different systems without parsing
260+
the payload. Events are routed for example in systems like Manufacturing Execution
261+
Systems (MES), Supervisory Control and Data Acquisition systems (SCADA),
262+
Alerting Systems or Operation Technology Operator Terminals (HMI Clients) and
263+
also in hot and/or cold path processing. The attributes
264264
`opcuametadatamajorversion` and `opcuametadataminorversion` are used to
265265
reference the correct metadata message.
266266

@@ -289,21 +289,21 @@ opcuametadataminorversion: 672341762
289289
------------------ payload -------------------
290290
291291
{
292-
... application data
292+
... application data
293293
(OPC UA PubSub JSON Single Event Message)...
294294
}
295295
296296
-----------------------------------------------
297297
```
298298

299-
### Telemetry message with different Encoding
299+
### Telemetry message with different Encoding
300300

301-
One major benefit of CloudEvents for OPC UA is that it is possible to support
302-
other encoding and external schema, while keeping the same OPC UA information for
301+
One major benefit of CloudEvents for OPC UA is that it is possible to support
302+
other encoding and external schema, while keeping the same OPC UA information for
303303
routing.
304304

305-
The example below uses Avro binary encoded payload, with the corresponding schema
306-
referenced by `dataschema`. The `source` will be defined by an customer defined
305+
The example below uses Avro binary encoded payload, with the corresponding schema
306+
referenced by `dataschema`. The `source` will be defined by an customer defined
307307
hierarchical path.
308308

309309
```text
@@ -329,7 +329,7 @@ recordedtime: 2024-03-28T23:59:59Z
329329
330330
------------------ payload -------------------
331331
332-
... application data
332+
... application data
333333
(OPC UA PubSub Single DataSet Message as AVRO binary)...
334334
335335
-----------------------------------------------

‎cloudevents/extensions/partitioning.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ described in [RFC 2119](https://tools.ietf.org/html/rfc2119).
1919

2020
However, the scope of these key words is limited to when this extension is
2121
used. For example, an attribute being marked as "REQUIRED" does not mean
22-
it needs to be in all CloudEvents, rather it needs to be included only when
22+
it needs to be in all CloudEvents, rather it needs to be included only when
2323
this extension is being used.
2424

2525
## Attributes

‎cloudevents/extensions/recordedtime.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ described in [RFC 2119](https://tools.ietf.org/html/rfc2119).
3030

3131
However, the scope of these key words is limited to when this extension is
3232
used. For example, an attribute being marked as "REQUIRED" does not mean
33-
it needs to be in all CloudEvents, rather it needs to be included only when
33+
it needs to be in all CloudEvents, rather it needs to be included only when
3434
this extension is being used.
3535

3636
## Attributes

‎cloudevents/extensions/sampledrate.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ described in [RFC 2119](https://tools.ietf.org/html/rfc2119).
3131

3232
However, the scope of these key words is limited to when this extension is
3333
used. For example, an attribute being marked as "REQUIRED" does not mean
34-
it needs to be in all CloudEvents, rather it needs to be included only when
34+
it needs to be in all CloudEvents, rather it needs to be included only when
3535
this extension is being used.
3636

3737
## Attributes

‎cloudevents/extensions/sequence.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ described in [RFC 2119](https://tools.ietf.org/html/rfc2119).
2323

2424
However, the scope of these key words is limited to when this extension is
2525
used. For example, an attribute being marked as "REQUIRED" does not mean
26-
it needs to be in all CloudEvents, rather it needs to be included only when
26+
it needs to be in all CloudEvents, rather it needs to be included only when
2727
this extension is being used.
2828

2929
## Attributes

0 commit comments

Comments
 (0)