The New Era Approaches

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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
asyncapi: "3.0.0"
info:
  title: Smartylighting Streetlights public API
  version: "1.0.0"
  description: |
    The Smartylighting Streetlights public API allows you to remotely manage the city lights through Kafka and WebSocket.

    ### Check out its awesome features:

    * Turn a specific streetlight on 🌃
    * Receive real-time information about environmental lighting conditions 📈
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0

servers:
  kafka:
    host: test.mykafkacluster.org:8092
    protocol: kafka-secure
    description: Test Kafka broker
    security:
      - $ref: '#/components/securitySchemes/saslScram'
  websocket:
    host: test.websocket.org:1999
    protocol: ws
    description: Test WebSocket server

defaultContentType: application/json

channels:
  turnStreetlightOnChannel:
    address: "/"
    messages:
      turnOn: 
        $ref: "#/components/messages/turnOn"
    servers:
      - $ref: "#/servers/websocket"

  turnStreetlightOnReplyChannel:
    address: "/"
    messages:
      turnOnReply: 
        $ref: "#/components/messages/turnOnReply"
    servers:
      - $ref: "#/servers/websocket"

  lightMeasured:
    description: The topic on which measured values may be produced and consumed.
    address: "smartylighting.streetlights.1.0.event.{streetlightId}.lighting.measured"
    parameters:
      streetlightId:
        $ref: "#/components/parameters/streetlightId"
    messages:
      lightMeasured: 
        $ref: "#/components/messages/lightMeasured"
    servers:
      - $ref: "#/servers/kafka"

operations:
  turnOn:
    action: send
    operationId: turnOn
    channel:
      $ref: "#/channels/turnStreetlightOnChannel"
    reply:
      channel:
        $ref: "#/channels/turnStreetlightOnReplyChannel"

  lightMeasured:
    action: receive
    summary: Inform about environmental lighting conditions of a particular streetlight.
    operationId: receiveLightMeasurement
    channel:
      $ref: "#/channels/lightMeasured"
    traits:
      - $ref: "#/components/operationTraits/kafka"

components:
  messages:
    turnOn:
      name: turnOn
      title: Turn on
      summary: Command a particular streetlight to turn the lights on.
      payload:
        $ref: "#/components/schemas/turnOnPayload"

    turnOnReply:
      name: turnOnReply
      title: Turn on reply
      summary: Reply from turning on the lights
      payload:
        $ref: "#/components/schemas/turnOnReplyPayload"

    lightMeasured:
      name: lightMeasured
      title: Light measured
      summary: Inform about environmental lighting conditions of a particular streetlight.
      contentType: application/json
      traits:
        - $ref: "#/components/messageTraits/commonHeaders"
      payload:
        $ref: "#/components/schemas/lightMeasuredPayload"

  schemas:
    turnOnPayload:
      type: object
      properties:
        streetlightId:
          description: The ID of the streetlight.
          type: string
        sentAt:
          type: string
          format: date-time
          description: Date and time when the request was sent

    turnOnReplyPayload:
      type: object
      properties:
        turnedOnTimestamp:
          type: string
          format: date-time
          description: Date and time when the light was actually turned on.

    lightMeasuredPayload:
      schemaFormat: "application/vnd.apache.avro;version=1.9.0"
      schema:
        type: record
        name: User
        namespace: com.company
        doc: User information
        fields:
          - name: lumens
            type: int
          - name: sentAt
            type: timestamp_ms

  securitySchemes:
    saslScram:
      type: scramSha256
      description: Provide your username and password for SASL/SCRAM authentication

  parameters:
    streetlightId:
      description: The ID of the streetlight.

  messageTraits:
    commonHeaders:
      headers:
        type: object
        properties:
          my-app-header:
            type: integer
            minimum: 0
            maximum: 100

  operationTraits:
    kafka:
      bindings:
        kafka:
          clientId: public