@asyncapi/cli 1.2.10 → 1.2.13

package/assets/examples/{application-headers.yml → application-headers-asyncapi.yml}

@@ -1,15 +1,15 @@
-asyncapi: '2.6.0'
+asyncapi: 3.0.0
 info:
   title: Application Headers example
-  version: '1.0.0'
-  description: A cut of the Streetlights API to test application header changes supporting #112
+  version: 1.0.0
+  description: A cut of the Streetlights API to test application header changes supporting
   license:
     name: Apache 2.0
-    url: https://www.apache.org/licenses/LICENSE-2.0
-
+    url: 'https://www.apache.org/licenses/LICENSE-2.0'
+defaultContentType: application/json
 servers:
   production:
-    url: test.mosquitto.org:{port}
+    host: 'test.mosquitto.org:{port}'
     protocol: mqtt
     description: Test broker
     variables:
@@ -19,28 +19,35 @@ servers:
         enum:
           - '1883'
           - '8883'
-
-defaultContentType: application/json
-
 channels:
-  smartylighting/streetlights/1/0/event/{streetlightId}/lighting/measured:
+  lightingMeasured:
+    address: 'smartylighting/streetlights/1/0/event/{streetlightId}/lighting/measured'
+    messages:
+      lightMeasured:
+        $ref: '#/components/messages/lightMeasured'
     parameters:
       streetlightId:
         $ref: '#/components/parameters/streetlightId'
-    publish:
-      summary: Inform about environmental lighting conditions of a particular streetlight.
-      operationId: receiveLightMeasurement
-      message:
-        $ref: '#/components/messages/lightMeasured'
-
+operations:
+  receiveLightMeasurement:
+    action: receive
+    channel:
+      $ref: '#/channels/lightingMeasured'
+    summary: >-
+      Inform about environmental lighting conditions of a particular
+      streetlight.
+    messages:
+      - $ref: '#/channels/lightingMeasured/messages/lightMeasured'
 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.
       correlationId:
-        location: "$message.header#/MQMD/CorrelId"
+        location: $message.header#/MQMD/CorrelId
       contentType: application/json
       headers:
         type: object
@@ -54,10 +61,9 @@ components:
                 maxLength: 24
                 format: binary
           applicationInstanceId:
-            $ref: "#/components/schemas/applicationInstanceId"
+            $ref: '#/components/schemas/applicationInstanceId'
       payload:
-        $ref: "#/components/schemas/lightMeasuredPayload"
-
+        $ref: '#/components/schemas/lightMeasuredPayload'
   schemas:
     lightMeasuredPayload:
       type: object
@@ -67,7 +73,7 @@ components:
           minimum: 0
           description: Light intensity measured in lumens.
         sentAt:
-          $ref: "#/components/schemas/sentAt"
+          $ref: '#/components/schemas/sentAt'
     sentAt:
       type: string
       format: date-time
@@ -75,9 +81,6 @@ components:
     applicationInstanceId:
       description: Unique identifier for a given instance of the publishing application
       type: string
-
   parameters:
     streetlightId:
-      description: The ID of the streetlight.
-      schema:
-        type: string
+      description: The ID of the streetlight.

package/assets/examples/{correlation-id.yml → correlation-id-asyncapi.yml}

@@ -1,15 +1,15 @@
-asyncapi: '2.6.0'
+asyncapi: 3.0.0
 info:
   title: Correlation ID Example
-  version: '1.0.0'
+  version: 1.0.0
   description: A cut of the Streetlights API to test Correlation ID
   license:
     name: Apache 2.0
-    url: https://www.apache.org/licenses/LICENSE-2.0
-
+    url: 'https://www.apache.org/licenses/LICENSE-2.0'
+defaultContentType: application/json
 servers:
   production:
-    url: test.mosquitto.org:{port}
+    host: 'test.mosquitto.org:{port}'
     protocol: mqtt
     description: Test broker
     variables:
@@ -20,55 +20,95 @@ servers:
           - '1883'
           - '8883'
     security:
-      - apiKey: []
-      - supportedOauthFlows:
-        - streetlights:on
-        - streetlights:off
-        - streetlights:dim
-      - openIdConnectWellKnown: []
-
-defaultContentType: application/json
-
+      - $ref: '#/components/securitySchemes/apiKey'
+      - type: oauth2
+        description: Flows to support OAuth 2.0
+        flows:
+          implicit:
+            authorizationUrl: 'https://authserver.example/auth'
+            availableScopes:
+              'streetlights:on': Ability to switch lights on
+              'streetlights:off': Ability to switch lights off
+              'streetlights:dim': Ability to dim the lights
+          password:
+            tokenUrl: 'https://authserver.example/token'
+            availableScopes:
+              'streetlights:on': Ability to switch lights on
+              'streetlights:off': Ability to switch lights off
+              'streetlights:dim': Ability to dim the lights
+          clientCredentials:
+            tokenUrl: 'https://authserver.example/token'
+            availableScopes:
+              'streetlights:on': Ability to switch lights on
+              'streetlights:off': Ability to switch lights off
+              'streetlights:dim': Ability to dim the lights
+          authorizationCode:
+            authorizationUrl: 'https://authserver.example/auth'
+            tokenUrl: 'https://authserver.example/token'
+            refreshUrl: 'https://authserver.example/refresh'
+            availableScopes:
+              'streetlights:on': Ability to switch lights on
+              'streetlights:off': Ability to switch lights off
+              'streetlights:dim': Ability to dim the lights
+        scopes:
+          - 'streetlights:on'
+          - 'streetlights:off'
+          - 'streetlights:dim'
+      - $ref: '#/components/securitySchemes/openIdConnectWellKnown'
 channels:
-  smartylighting/streetlights/1/0/event/{streetlightId}/lighting/measured:
+  lightingMeasured:
+    address: 'smartylighting/streetlights/1/0/event/{streetlightId}/lighting/measured'
+    messages:
+      lightMeasured:
+        $ref: '#/components/messages/lightMeasured'
     parameters:
       streetlightId:
         $ref: '#/components/parameters/streetlightId'
-    publish:
-      summary: Inform about environmental lighting conditions of a particular streetlight.
-      operationId: receiveLightMeasurement
-      message:
-        $ref: '#/components/messages/lightMeasured'
-
-  smartylighting/streetlights/1/0/action/{streetlightId}/dim:
+  lightsDim:
+    address: 'smartylighting/streetlights/1/0/action/{streetlightId}/dim'
+    messages:
+      dimLight:
+        $ref: '#/components/messages/dimLight'
     parameters:
       streetlightId:
         $ref: '#/components/parameters/streetlightId'
-    subscribe:
-      operationId: dimLight
-      message:
-        $ref: '#/components/messages/dimLight'
-
+operations:
+  receiveLightMeasurement:
+    action: receive
+    channel:
+      $ref: '#/channels/lightingMeasured'
+    summary: >-
+      Inform about environmental lighting conditions of a particular
+      streetlight.
+    messages:
+      - $ref: '#/channels/lightingMeasured/messages/lightMeasured'
+  dimLight:
+    action: send
+    channel:
+      $ref: '#/channels/lightsDim'
+    messages:
+      - $ref: '#/channels/lightsDim/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.
       correlationId:
-        location: "$message.header#/MQMD/CorrelId"
+        location: $message.header#/MQMD/CorrelId
       contentType: application/json
       payload:
-        $ref: "#/components/schemas/lightMeasuredPayload"
+        $ref: '#/components/schemas/lightMeasuredPayload'
     dimLight:
       name: dimLight
       title: Dim light
       summary: Command a particular streetlight to dim the lights.
       correlationId:
-        $ref: "#/components/correlationIds/sentAtCorrelator"
+        $ref: '#/components/correlationIds/sentAtCorrelator'
       payload:
-        $ref: "#/components/schemas/dimLightPayload"
-
+        $ref: '#/components/schemas/dimLightPayload'
   schemas:
     lightMeasuredPayload:
       type: object
@@ -78,7 +118,7 @@ components:
           minimum: 0
           description: Light intensity measured in lumens.
         sentAt:
-          $ref: "#/components/schemas/sentAt"
+          $ref: '#/components/schemas/sentAt'
     dimLightPayload:
       type: object
       properties:
@@ -88,18 +128,14 @@ 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.
-
   parameters:
     streetlightId:
       description: The ID of the streetlight.
-      schema:
-        type: string
-
   correlationIds:
     sentAtCorrelator:
       description: Data from message payload used as correlation ID
@@ -115,19 +151,19 @@ components:
       flows:
         implicit:
           authorizationUrl: 'https://authserver.example/auth'
-          scopes:
+          availableScopes:
             'streetlights:on': Ability to switch lights on
             'streetlights:off': Ability to switch lights off
             'streetlights:dim': Ability to dim the lights
         password:
           tokenUrl: 'https://authserver.example/token'
-          scopes:
+          availableScopes:
             'streetlights:on': Ability to switch lights on
             'streetlights:off': Ability to switch lights off
             'streetlights:dim': Ability to dim the lights
         clientCredentials:
           tokenUrl: 'https://authserver.example/token'
-          scopes:
+          availableScopes:
             'streetlights:on': Ability to switch lights on
             'streetlights:off': Ability to switch lights off
             'streetlights:dim': Ability to dim the lights
@@ -135,10 +171,10 @@ components:
           authorizationUrl: 'https://authserver.example/auth'
           tokenUrl: 'https://authserver.example/token'
           refreshUrl: 'https://authserver.example/refresh'
-          scopes:
+          availableScopes:
             'streetlights:on': Ability to switch lights on
             'streetlights:off': Ability to switch lights off
             'streetlights:dim': Ability to dim the lights
     openIdConnectWellKnown:
       type: openIdConnect
-      openIdConnectUrl: 'https://authserver.example/.well-known'
+      openIdConnectUrl: 'https://authserver.example/.well-known'

package/assets/examples/examples.json

@@ -1,55 +1,67 @@
 [
     {
         "name": "Account Service",
-        "value": "simple.yml"
+        "value": "simple-asyncapi.yml"
+    },
+    {
+        "name": "Adeo AsyncAPI Case Study - (protocols: kafka,kafka,kafka)",
+        "value": "adeo-kafka-request-reply-asyncapi.yml"
     },
     {
         "name": "AnyOf example",
-        "value": "anyof.yml"
+        "value": "anyof-asyncapi.yml"
     },
     {
         "name": "Application Headers example - (protocols: mqtt)",
-        "value": "application-headers.yml"
+        "value": "application-headers-asyncapi.yml"
     },
     {
         "name": "Correlation ID Example - (protocols: mqtt)",
-        "value": "correlation-id.yml"
+        "value": "correlation-id-asyncapi.yml"
     },
     {
         "name": "Gemini Market Data Websocket API - (protocols: wss)",
-        "value": "websocket-gemini.yml"
+        "value": "websocket-gemini-asyncapi.yml"
     },
     {
         "name": "Gitter Streaming API - (protocols: https)",
-        "value": "gitter-streaming.yml"
+        "value": "gitter-streaming-asyncapi.yml"
+    },
+    {
+        "name": "Kraken Websockets API",
+        "value": "kraken-websocket-request-reply-message-filter-in-reply-asyncapi.yml"
+    },
+    {
+        "name": "Kraken Websockets API",
+        "value": "kraken-websocket-request-reply-multiple-channels-asyncapi.yml"
     },
     {
         "name": "Mercure Hub Example - (protocols: mercure)",
-        "value": "mercure.yml"
+        "value": "mercure-asyncapi.yml"
     },
     {
         "name": "Not example",
-        "value": "not.yml"
+        "value": "not-asyncapi.yml"
     },
     {
         "name": "Notifications",
-        "value": "operation-security.yml"
+        "value": "operation-security-asyncapi.yml"
     },
     {
         "name": "OneOf example",
-        "value": "oneof.yml"
+        "value": "oneof-asyncapi.yml"
     },
     {
         "name": "RPC Client Example - (protocols: amqp)",
-        "value": "rpc-client.yml"
+        "value": "rpc-client-asyncapi.yml"
     },
     {
         "name": "RPC Server Example - (protocols: amqp)",
-        "value": "rpc-server.yml"
+        "value": "rpc-server-asyncapi.yml"
     },
     {
         "name": "Slack Real Time Messaging API - (protocols: https)",
-        "value": "slack-rtm.yml"
+        "value": "slack-rtm-asyncapi.yml"
     },
     {
         "name": "Streetlights App - (protocols: mqtt)",
@@ -57,14 +69,14 @@
     },
     {
         "name": "Streetlights Kafka API - (protocols: kafka-secure,kafka-secure)",
-        "value": "streetlights-kafka.yml"
+        "value": "streetlights-kafka-asyncapi.yml"
     },
     {
         "name": "Streetlights Kafka API - (protocols: kafka-secure,kafka-secure)",
-        "value": "streetlights-operation-security.yml"
+        "value": "streetlights-operation-security-asyncapi.yml"
     },
     {
         "name": "Streetlights MQTT API - (protocols: mqtt)",
-        "value": "streetlights-mqtt.yml"
+        "value": "streetlights-mqtt-asyncapi.yml"
     }
 ]

package/assets/examples/gitter-streaming-asyncapi.yml

@@ -0,0 +1,178 @@
+asyncapi: 3.0.0
+id: 'tag:stream.gitter.im,2022:api'
+info:
+  title: Gitter Streaming API
+  version: 1.0.0
+servers:
+  production:
+    host: stream.gitter.im
+    pathname: /v1
+    protocol: https
+    protocolVersion: '1.1'
+    security:
+      - $ref: '#/components/securitySchemes/httpBearerToken'
+channels:
+  rooms:
+    address: '/rooms/{roomId}/{resource}'
+    messages:
+      chatMessage:
+        $ref: '#/components/messages/chatMessage'
+      heartbeat:
+        $ref: '#/components/messages/heartbeat'
+    parameters:
+      roomId:
+        description: Id of the Gitter room.
+        examples:
+          - 53307860c3599d1de448e19d
+      resource:
+        enum:
+          - chatMessages
+          - events
+        description: The resource to consume.
+operations:
+  sendRoomInfo:
+    action: send
+    channel:
+      $ref: '#/channels/rooms'
+    bindings:
+      http:
+        method: POST
+    messages:
+      - $ref: '#/channels/rooms/messages/chatMessage'
+      - $ref: '#/channels/rooms/messages/heartbeat'
+components:
+  securitySchemes:
+    httpBearerToken:
+      type: http
+      scheme: bearer
+  messages:
+    chatMessage:
+      summary: >-
+        A message represents an individual chat message sent to a room. They are
+        a sub-resource of a room.
+      payload:
+        schemaFormat: application/schema+yaml;version=draft-07
+        schema:
+          type: object
+          properties:
+            id:
+              type: string
+              description: ID of the message.
+            text:
+              type: string
+              description: Original message in plain-text/markdown.
+            html:
+              type: string
+              description: HTML formatted message.
+            sent:
+              type: string
+              format: date-time
+              description: ISO formatted date of the message.
+            fromUser:
+              type: object
+              description: User that sent the message.
+              properties:
+                id:
+                  type: string
+                  description: Gitter User ID.
+                username:
+                  type: string
+                  description: Gitter/GitHub username.
+                displayName:
+                  type: string
+                  description: Gitter/GitHub user real name.
+                url:
+                  type: string
+                  description: Path to the user on Gitter.
+                avatarUrl:
+                  type: string
+                  format: uri
+                  description: User avatar URI.
+                avatarUrlSmall:
+                  type: string
+                  format: uri
+                  description: User avatar URI (small).
+                avatarUrlMedium:
+                  type: string
+                  format: uri
+                  description: User avatar URI (medium).
+                v:
+                  type: number
+                  description: Version.
+                gv:
+                  type: string
+                  description: Stands for "Gravatar version" and is used for cache busting.
+            unread:
+              type: boolean
+              description: Boolean that indicates if the current user has read the message.
+            readBy:
+              type: number
+              description: Number of users that have read the message.
+            urls:
+              type: array
+              description: List of URLs present in the message.
+              items:
+                type: string
+                format: uri
+            mentions:
+              type: array
+              description: List of @Mentions in the message.
+              items:
+                type: object
+                properties:
+                  screenName:
+                    type: string
+                  userId:
+                    type: string
+                  userIds:
+                    type: array
+                    items:
+                      type: string
+            issues:
+              type: array
+              description: 'List of #Issues referenced in the message.'
+              items:
+                type: object
+                properties:
+                  number:
+                    type: string
+            meta:
+              type: array
+              description: Metadata. This is currently not used for anything.
+              items: {}
+            v:
+              type: number
+              description: Version.
+            gv:
+              type: string
+              description: Stands for "Gravatar version" and is used for cache busting.
+      bindings:
+        http:
+          headers:
+            type: object
+            properties:
+              Transfer-Encoding: 
+                type: string
+                const: chunked
+              Trailer: 
+                type: string
+                const: \r\n
+    heartbeat:
+      summary: Its purpose is to keep the connection alive.
+      payload:
+        schemaFormat: application/schema+yaml;version=draft-07
+        schema:
+          type: string
+          enum:
+            - "\r\n"
+      bindings:
+        http:
+          headers:
+            type: object
+            properties:
+              Transfer-Encoding: 
+                type: string
+                const: chunked
+              Trailer: 
+                type: string
+                const: \r\n