Skip to content

Commit 0badb9c

Browse files
committed
feature: add CloudEvents Message Traits as a component
#1102
1 parent 4ac3821 commit 0badb9c

File tree

1 file changed

+67
-0
lines changed

1 file changed

+67
-0
lines changed

components/cloudevents.yml

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
asyncapi: 3.0.0
2+
info:
3+
title: CloudEvents Message Traits
4+
version: 1.0.0
5+
description: |
6+
Official AsyncAPI [CloudEvents](https://github.com/cloudevents/spec/tree/main/cloudevents) message traits for various protocols.
7+
8+
The propper usage is described here: https://www.asyncapi.com/docs/reference/message-formats/cloudevents.
9+
10+
components:
11+
messageTraits:
12+
cloudevents-headers-kafka-binary:
13+
summary: Message headers for CloudEvents in binary content mode with Kafka (see https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/bindings/kafka-protocol-binding.md)
14+
headers:
15+
type: object
16+
required:
17+
- ce_id
18+
- ce_source
19+
- ce_specversion
20+
- ce_type
21+
properties:
22+
ce_id:
23+
type: string
24+
minLength: 1
25+
description: Identifies the event.
26+
examples:
27+
- "1234-1234-1234"
28+
ce_source:
29+
type: string
30+
format: uri-reference
31+
minLength: 1
32+
description: Identifies the context in which an event happened.
33+
examples:
34+
- "https://example.com/storage/tenant/container"
35+
ce_specversion:
36+
type: string
37+
description: The version of the CloudEvents specification which the event uses.
38+
enum:
39+
- "1.0"
40+
ce_type:
41+
type: string
42+
minLength: 1
43+
description: Describes the type of event related to the originating occurrence.
44+
examples:
45+
- "com.example.someevent"
46+
content-type:
47+
type: string
48+
description: Kafka default field to describing the content type of the data. Must be mapped directly to the CloudEvents datacontenttype attribute.
49+
examples:
50+
- "application/avro"
51+
- "application/json;charset=utf-8"
52+
ce_dataschema:
53+
type: string
54+
description: Identifies the schema that data adheres to.
55+
examples:
56+
- "http://registry.com/schema/v1/much.json"
57+
ce_subject:
58+
type: string
59+
description: Describes the subject of the event in the context of the event producer (identified by source)
60+
examples:
61+
- mynewfile.jpg
62+
ce_time:
63+
type: string
64+
format: date-time
65+
description: Timestamp of when the occurrence happened. Must adhere to RFC 3339.
66+
examples:
67+
- "2018-04-05T17:31:00Z"

0 commit comments

Comments
 (0)