sourceos-spec/asyncapi.truth-plane.patch.yaml at main · SourceOS-Linux/sourceos-spec · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
# Additive AsyncAPI patch fragment for the Truth Plane.
# Merge this file into asyncapi.yaml at build time using @asyncapi/bundler.
# All channels use Kafka with the same broker configuration as the base spec.

channels:
  srcos.v2.truth.events:
    description: Events emitted when a TruthSurface is recorded or updated.
    bindings:
      kafka:
        topic: srcos.v2.truth.events
        partitions: 3
        replicas: 3
        topicConfiguration:
          retention.ms: 2592000000
          cleanup.policy: delete
    publish:
      operationId: publishTruthSurfaceEvent
      summary: Publish a truth surface domain event
      description: Publishes an event whenever a TruthSurface is upserted.
      message:
        name: TruthSurfaceEvent
        title: Truth Surface Domain Event
        summary: A change event for a TruthSurface.
        description: |
          The `eventType` in the payload envelope identifies the specific change:
          - `TruthSurfaceUpserted` — a TruthSurface was created or updated
        contentType: application/json
        payload: { $ref: './schemas/EventEnvelope.json' }
        bindings:
          kafka:
            key:
              type: string
              description: The `objectId` URN of the TruthSurface.

  srcos.v2.delta.events:
    description: Events emitted when a DeltaSurface is recorded.
    bindings:
      kafka:
        topic: srcos.v2.delta.events
        partitions: 3
        replicas: 3
        topicConfiguration:
          retention.ms: 2592000000
          cleanup.policy: delete
    publish:
      operationId: publishDeltaSurfaceEvent
      summary: Publish a delta surface domain event
      description: Publishes an event whenever a DeltaSurface is recorded.
      message:
        name: DeltaSurfaceEvent
        title: Delta Surface Domain Event
        summary: A record event for a DeltaSurface.
        description: |
          The `eventType` in the payload envelope is `DeltaSurfaceRecorded`.
          The payload contains the full DeltaSurface object.
        contentType: application/json
        payload: { $ref: './schemas/EventEnvelope.json' }
        bindings:
          kafka:
            key:
              type: string
              description: The `objectId` URN of the DeltaSurface.

  srcos.v2.incident.events:
    description: Events emitted when an incident lifecycle event (freeze/fork/kill) is recorded.
    bindings:
      kafka:
        topic: srcos.v2.incident.events
        partitions: 3
        replicas: 3
        topicConfiguration:
          retention.ms: 2592000000
          cleanup.policy: delete
    publish:
      operationId: publishIncidentEvent
      summary: Publish an incident domain event
      description: Publishes an event whenever an incident lifecycle event is recorded.
      message:
        name: IncidentEvent
        title: Incident Domain Event
        summary: A lifecycle event for an incident phase.
        description: |
          The `eventType` in the payload envelope identifies the specific change:
          - `IncidentFreezeRecorded`
          - `IncidentForkRecorded`
          - `IncidentKillRecorded`
        contentType: application/json
        payload: { $ref: './schemas/EventEnvelope.json' }
        bindings:
          kafka:
            key:
              type: string
              description: The `objectId` URN of the incident event.