fix: update default docs

asyncapi · Oct 17, 2023 · bec4ce9 · bec4ce9
1 parent c0fd61c
commit bec4ce9
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 29 deletions.
diff --git a/public/docs/asyncapi/asyncapi.json b/public/docs/asyncapi/asyncapi.json
@@ -1,9 +1,9 @@
 {
-  "asyncapi": "2.4.0",
+  "asyncapi": "2.6.0",
   "info": {
     "title": "Streetlights Kafka API",
     "version": "1.0.0",
-    "description": "The Smartylighting Streetlights API allows you to remotely manage the city lights.\n\n### Check out its awesome features:\n\n* Turn a specific streetlight on/off 🌃\n* Dim a specific streetlight 😎\n* Receive real-time information about environmental lighting conditions 📈\n",
+    "description": "The Smartylighting Streetlights API allows you to remotely manage the city lights.\n### Check out its awesome features:\n* Turn a specific streetlight on/off 🌃\n* Dim a specific streetlight 😎\n* Receive real-time information about environmental lighting conditions 📈\n",
     "license": {
       "name": "Apache 2.0",
       "url": "https://www.apache.org/licenses/LICENSE-2.0"
@@ -229,4 +229,4 @@
       }
     }
   }
-}
+}
diff --git a/public/docs/asyncapi/asyncapi.yaml b/public/docs/asyncapi/asyncapi.yaml
@@ -1,43 +1,44 @@
-asyncapi: '2.4.0'
+asyncapi: 2.6.0
 info:
   title: Streetlights Kafka API
-  version: '1.0.0'
-  description: |
-    The Smartylighting Streetlights API allows you to remotely manage the city lights.
+  version: 1.0.0
+  description: >
+    The Smartylighting Streetlights API allows you to remotely manage the city
+    lights.
 
     ### Check out its awesome features:
 
     * Turn a specific streetlight on/off 🌃
+
     * Dim a specific streetlight 😎
+
     * Receive real-time information about environmental lighting conditions 📈
   license:
     name: Apache 2.0
     url: https://www.apache.org/licenses/LICENSE-2.0
-
 servers:
   test:
     url: test.mykafkacluster.org:8092
     protocol: kafka-secure
     description: Test broker
     security:
       - saslScram: []
-
 defaultContentType: application/json
-
 channels:
   smartylighting.streetlights.1.0.event.{streetlightId}.lighting.measured:
     description: The topic on which measured values may be produced and consumed.
     parameters:
       streetlightId:
         $ref: '#/components/parameters/streetlightId'
     publish:
-      summary: Inform about environmental lighting conditions of a particular streetlight.
+      summary: >-
+        Inform about environmental lighting conditions of a particular
+        streetlight.
       operationId: receiveLightMeasurement
       traits:
         - $ref: '#/components/operationTraits/kafka'
       message:
         $ref: '#/components/messages/lightMeasured'
-
   smartylighting.streetlights.1.0.action.{streetlightId}.turn.on:
     parameters:
       streetlightId:
@@ -48,7 +49,6 @@ channels:
         - $ref: '#/components/operationTraits/kafka'
       message:
         $ref: '#/components/messages/turnOnOff'
-
   smartylighting.streetlights.1.0.action.{streetlightId}.turn.off:
     parameters:
       streetlightId:
@@ -59,7 +59,6 @@ channels:
         - $ref: '#/components/operationTraits/kafka'
       message:
         $ref: '#/components/messages/turnOnOff'
-
   smartylighting.streetlights.1.0.action.{streetlightId}.dim:
     parameters:
       streetlightId:
@@ -70,35 +69,35 @@ channels:
         - $ref: '#/components/operationTraits/kafka'
       message:
         $ref: '#/components/messages/dimLight'
-
 components:
   messages:
     lightMeasured:
       name: lightMeasured
       title: Light measured
-      summary: Inform about environmental lighting conditions of a particular streetlight.
+      summary: >-
+        Inform about environmental lighting conditions of a particular
+        streetlight.
       contentType: application/json
       traits:
         - $ref: '#/components/messageTraits/commonHeaders'
       payload:
-        $ref: "#/components/schemas/lightMeasuredPayload"
+        $ref: '#/components/schemas/lightMeasuredPayload'
     turnOnOff:
       name: turnOnOff
       title: Turn on/off
       summary: Command a particular streetlight to turn the lights on or off.
       traits:
         - $ref: '#/components/messageTraits/commonHeaders'
       payload:
-        $ref: "#/components/schemas/turnOnOffPayload"
+        $ref: '#/components/schemas/turnOnOffPayload'
     dimLight:
       name: dimLight
       title: Dim light
       summary: Command a particular streetlight to dim the lights.
       traits:
         - $ref: '#/components/messageTraits/commonHeaders'
       payload:
-        $ref: "#/components/schemas/dimLightPayload"
-
+        $ref: '#/components/schemas/dimLightPayload'
   schemas:
     lightMeasuredPayload:
       type: object
@@ -108,18 +107,18 @@ components:
           minimum: 0
           description: Light intensity measured in lumens.
         sentAt:
-          $ref: "#/components/schemas/sentAt"
+          $ref: '#/components/schemas/sentAt'
     turnOnOffPayload:
       type: object
       properties:
         command:
           type: string
           enum:
-            - on
-            - off
+            - 'on'
+            - 'off'
           description: Whether to turn on or off the light.
         sentAt:
-          $ref: "#/components/schemas/sentAt"
+          $ref: '#/components/schemas/sentAt'
     dimLightPayload:
       type: object
       properties:
@@ -129,23 +128,20 @@ components:
           minimum: 0
           maximum: 100
         sentAt:
-          $ref: "#/components/schemas/sentAt"
+          $ref: '#/components/schemas/sentAt'
     sentAt:
       type: string
       format: date-time
       description: Date and time when the message was sent.
-
   securitySchemes:
     saslScram:
       type: scramSha256
       description: Provide your username and password for SASL/SCRAM authentication
-
   parameters:
     streetlightId:
       description: The ID of the streetlight.
       schema:
         type: string
-
   messageTraits:
     commonHeaders:
       headers:
@@ -155,7 +151,6 @@ components:
             type: integer
             minimum: 0
             maximum: 100
-
   operationTraits:
     kafka:
       bindings: