@asyncapi-actions-test/trusted-publishing-test_asyncapi-cli 4.1.3

package/assets/create-template/templates/default/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "myTemplate",
+  "generator": {
+    "renderer": "react",
+    "supportedProtocols": []
+  },
+  "dependencies": {
+    "@asyncapi/generator-react-sdk": "^1.1.2"
+  }
+}

package/assets/create-template/templates/default/readme.md

@@ -0,0 +1,4 @@
+### First install all the dependencies for template using below command:
+npm install 
+### Run the template using for a specific asyncapi document 
+ asyncapi generate fromTemplate <templateName> ../asyncapi-template 

package/assets/create-template/templates/default/template/index.js

@@ -0,0 +1,11 @@
+import { File, Text } from '@asyncapi/generator-react-sdk';
+
+// Pass the others parameters to get the specificatin of the asyncapi document
+export default function ({ asyncapi }) {
+  return (
+    <File name="asyncapi.md">
+      <Text>My application's markdown file.</Text>
+      <Text>App name: **{asyncapi.info().title()}**</Text>
+    </File>
+  );
+}

package/assets/examples/adeo-kafka-request-reply-asyncapi.yml

@@ -0,0 +1,298 @@
+asyncapi: 3.0.0
+info:
+  title: Adeo AsyncAPI Case Study
+  version: '%REPLACED_BY_MAVEN%'
+  description: >
+    This Adeo specification illustrates how ADEO uses AsyncAPI to document some
+    of their exchanges.
+  contact:
+    name: AsyncAPI Community
+    email: case-study@asyncapi.com
+  tags:
+    - name: costing
+      description: Costing channels, used by Costing clients.
+servers:
+  production:
+    host: prod.url:9092
+    protocol: kafka
+    description: Kafka PRODUCTION cluster
+    security:
+      - $ref: '#/components/securitySchemes/sasl-ssl'
+    bindings:
+      kafka:
+        schemaRegistryUrl: https://schema-registry.prod.url/
+  staging:
+    host: staging.url:9092
+    protocol: kafka
+    description: Kafka STAGING cluster for `uat` and `preprod` environments
+    security:
+      - $ref: '#/components/securitySchemes/sasl-ssl'
+    bindings:
+      kafka:
+        schemaRegistryUrl: https://schema-registry.prod.url/
+  dev:
+    host: dev.url:9092
+    protocol: kafka
+    description: Kafka DEV cluster for `dev` and `sit` environments
+    security:
+      - $ref: '#/components/securitySchemes/sasl-ssl'
+    bindings:
+      kafka:
+        schemaRegistryUrl: https://schema-registry.prod.url/
+channels:
+  costingRequestChannel:
+    address: adeo-{env}-case-study-COSTING-REQUEST-{version}
+    description: >
+      Use this topic to do a Costing Request to Costing product. We use the
+      [**RecordNameStrategy**](https://docs.confluent.io/platform/current/schema-registry/serdes-develop/index.html#subject-name-strategy)
+      to infer the messages schema. You have to define
+      `value.subject.name.strategy` to
+      `io.confluent.kafka.serializers.subject.RecordNameStrategy` in your
+      producer to use the schema we manage. The schema below illustrates how
+      Costing Request messages are handled.
+      ![](https://user-images.githubusercontent.com/5501911/188920831-689cec5f-8dc3-460b-8794-0b54ec8b0ac8.png)
+    parameters:
+      env:
+        $ref: '#/components/parameters/Env'
+      version:
+        $ref: '#/components/parameters/Version'
+    bindings:
+      kafka:
+        replicas: 3
+        partitions: 3
+        topicConfiguration:
+          cleanup.policy:
+            - delete
+          retention.ms: 60000000
+    messages:
+      CostingRequest:
+        $ref: '#/components/messages/costingRequestV1'
+  costingResponseChannel:
+    address: null
+    description: >
+      This topic is used to REPLY Costing Requests and is targeted by the
+      `REPLY_TOPIC` header. **You must grant PUBLISH access to our `svc-ccr-app`
+      service account.**. We use the
+      [**RecordNameStrategy**](https://docs.confluent.io/platform/current/schema-registry/serdes-develop/index.html#subject-name-strategy)
+      to infer the messages schema. 
+      
+      Topic should follow pattern "adeo-{env}-case-study-COSTING-RESPONSE-{version}"
+
+      You have to define
+      `key.subject.name.strategy` and `value.subject.name.strategy` to
+      `io.confluent.kafka.serializers.subject.RecordNameStrategy` in your
+      consumer. The schema below illustrates how Costing Response messages are
+      handled.
+           ![](https://user-images.githubusercontent.com/5501911/188920831-689cec5f-8dc3-460b-8794-0b54ec8b0ac8.png)
+
+    bindings:
+      kafka:
+        x-key.subject.name.strategy:
+          type: string
+          description: >
+            We use the RecordNameStrategy to infer the messages schema. Use
+            `key.subject.name.strategy=io.confluent.kafka.serializers.subject.RecordNameStrategy`
+            in your consumer configuration.
+        x-value.subject.name.strategy:
+          type: string
+          description: >
+            We use the RecordNameStrategy to infer the messages schema. Use
+            `value.subject.name.strategy=io.confluent.kafka.serializers.subject.RecordNameStrategy`
+            in your consumer configuration.
+    tags:
+      - name: costing
+    messages:
+      costingResponse:
+        $ref: '#/components/messages/costingResponse'
+operations:
+  receiveACostingRequest:
+    action: receive
+    channel:
+      $ref: '#/channels/costingRequestChannel'
+    reply:
+      channel:
+        $ref: '#/channels/costingResponseChannel'
+      address:
+        location: $message.header#/REPLY_TOPIC
+    summary: |
+      [COSTING] Request one or more Costing calculation for any product
+    description: >
+      You can try a costing request using our [Conduktor producer
+      template](https://conduktor.url/)
+    tags:
+      - name: costing
+    bindings:
+      kafka:
+        groupId:
+          type: string
+          description: >
+            The groupId must be prefixed by your `svc` account, deliver by the
+            Adeo Kafka team. This `svc` must have the write access to the topic.
+        x-value.subject.name.strategy:
+          type: string
+          description: >
+            We use the RecordNameStrategy to infer the messages schema. Use
+            `value.subject.name.strategy=io.confluent.kafka.serializers.subject.RecordNameStrategy`
+            in your producer configuration.
+
+components:
+  correlationIds:
+    costingCorrelationId:
+      description: >
+        This correlation ID is used for message tracing and messages
+        correlation. This correlation ID is generated at runtime based on the
+        `REQUEST_ID` and sent to the RESPONSE message.
+      location: $message.header#/REQUEST_ID
+  messages:
+    costingRequestV1:
+      name: CostingRequestV1
+      title: Costing Request V1
+      summary: Costing Request V1 inputs.
+      tags:
+        - name: costing
+      correlationId:
+        $ref: '#/components/correlationIds/costingCorrelationId'
+      headers:
+        type: object
+        required:
+          - REQUESTER_ID
+          - REQUESTER_CODE
+          - REQUEST_ID
+          - REPLY_TOPIC
+        properties:
+          REQUEST_ID:
+            $ref: '#/components/schemas/RequestId'
+          REPLY_TOPIC:
+            $ref: '#/components/schemas/ReplyTopic'
+          REQUESTER_ID:
+            $ref: '#/components/schemas/RequesterId'
+          REQUESTER_CODE:
+            $ref: '#/components/schemas/RequesterCode'
+      payload:
+        schemaFormat: application/vnd.apache.avro;version=1.9.0
+        schema:
+          $ref: https://www.asyncapi.com/resources/casestudies/adeo/CostingRequestPayload.avsc
+    costingResponse:
+      name: CostingResponse
+      title: Costing Response
+      summary: Costing Response ouputs.
+      tags:
+        - name: costing
+      description: >
+        Please refer to the `CostingResponseKey.avsc` schema, available on [our
+        github project](https://github.url/).
+      correlationId:
+        $ref: '#/components/correlationIds/costingCorrelationId'
+      headers:
+        type: object
+        properties:
+          CALCULATION_ID:
+            $ref: '#/components/schemas/MessageId'
+          CORRELATION_ID:
+            $ref: '#/components/schemas/CorrelationId'
+          REQUEST_TIMESTAMP:
+            type: string
+            format: date-time
+            description: Timestamp of the costing request
+          CALCULATION_TIMESTAMP:
+            type: string
+            format: date-time
+            description: Technical timestamp for the costing calculation
+      payload:
+        schemaFormat: application/vnd.apache.avro;version=1.9.0
+        schema:
+          $ref: https://www.asyncapi.com/resources/casestudies/adeo/CostingResponsePayload.avsc
+  schemas:
+    RequesterId:
+      type: string
+      description: The Costing requester service account used to produce costing request.
+      examples:
+        - svc-ecollect-app
+    RequesterCode:
+      type: string
+      description: >-
+        The Costing requester code (generally the BU Code). The requester code
+        is useful to get the dedicated context (tenant).
+      examples:
+        - 1
+    MessageId:
+      type: string
+      format: uuid
+      description: A unique Message ID.
+      examples:
+        - 1fa6ef40-8f47-40a8-8cf6-f8607d0066ef
+    RequestId:
+      type: string
+      format: uuid
+      description: >-
+        A unique Request ID needed to define a `CORRELATION_ID` for exchanges,
+        which will be sent back in the Costing Responses.
+      examples:
+        - 1fa6ef40-8f47-40a8-8cf6-f8607d0066ef
+    CorrelationId:
+      type: string
+      format: uuid
+      description: >-
+        A unique Correlation ID defined from the `REQUEST_ID` or the
+        `MESSAGE_ID` provided in the Costing Request.
+      examples:
+        - 1fa6ef40-8f47-40a8-8cf6-f8607d0066ef
+    BuCode:
+      type: string
+      description: The Business Unit code for which data are applicable.
+      examples:
+        - 1
+    ReplyTopic:
+      type: string
+      description: >
+        The Kafka topic where to send the Costing Response. This is required for
+        the [Return Address EIP
+        pattern](https://www.enterpriseintegrationpatterns.com/patterns/messaging/ReturnAddress.html).
+        **You must grant WRITE access to our `svc-ccr-app` service account.**
+      examples:
+        - adeo-case-study-COSTING-RESPONSE-V1
+    ErrorStep:
+      type: string
+      description: |
+        The woker that has thrown the error.
+      examples:
+        - EXPOSE_RESULT
+    ErrorMessage:
+      type: string
+      description: |
+        The error message describing the error.
+      examples:
+        - Error message
+    ErrorCode:
+      type: string
+      description: |
+        The error code.
+      examples:
+        - CURRENCY_NOT_FOUND
+  parameters:
+    Env:
+      description: Adeo Kafka Environement for messages publications.
+      enum:
+        - dev
+        - sit
+        - uat1
+        - preprod
+        - prod
+    Version:
+      description: the topic version you want to use
+      examples:
+        - V1
+      default: V1
+  securitySchemes:
+    sasl-ssl:
+      type: plain
+      x-sasl.jaas.config: >-
+        org.apache.kafka.common.security.plain.PlainLoginModule required
+        username="<CLUSTER_API_KEY>" password="<CLUSTER_API_SECRET>";
+      x-security.protocol: SASL_SSL
+      x-ssl.endpoint.identification.algorithm: https
+      x-sasl.mechanism: PLAIN
+      description: >
+        Use [SASL authentication with SSL
+        encryption](https://docs.confluent.io/platform/current/security/security_tutorial.html#configure-clients)
+        to connect to the ADEO Broker.

package/assets/examples/anyof-asyncapi.yml

@@ -0,0 +1,36 @@
+asyncapi: 3.0.0
+info:
+  title: AnyOf example
+  version: 1.0.0
+channels:
+  test:
+    address: test
+    messages:
+      testMessages:
+        $ref: '#/components/messages/testMessages'
+operations:
+  test:
+    action: receive
+    channel:
+      $ref: '#/channels/test'
+    messages:
+      - $ref: '#/channels/test/messages/testMessages'
+components:
+  messages:
+    testMessages:
+      payload:
+        anyOf:
+          - $ref: '#/components/schemas/objectWithKey'
+          - $ref: '#/components/schemas/objectWithKey2'
+  schemas:
+    objectWithKey:
+      type: object
+      properties:
+        key:
+          type: string
+          additionalProperties: false
+    objectWithKey2:
+      type: object
+      properties:
+        key2:
+          type: string

package/assets/examples/application-headers-asyncapi.yml

@@ -0,0 +1,86 @@
+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
+  license:
+    name: Apache 2.0
+    url: 'https://www.apache.org/licenses/LICENSE-2.0'
+defaultContentType: application/json
+servers:
+  production:
+    host: 'test.mosquitto.org:{port}'
+    protocol: mqtt
+    description: Test broker
+    variables:
+      port:
+        description: Secure connection (TLS) is available through port 8883.
+        default: '1883'
+        enum:
+          - '1883'
+          - '8883'
+channels:
+  lightingMeasured:
+    address: 'smartylighting/streetlights/1/0/event/{streetlightId}/lighting/measured'
+    messages:
+      lightMeasured:
+        $ref: '#/components/messages/lightMeasured'
+    parameters:
+      streetlightId:
+        $ref: '#/components/parameters/streetlightId'
+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.
+      correlationId:
+        location: $message.header#/MQMD/CorrelId
+      contentType: application/json
+      headers:
+        type: object
+        properties:
+          MQMD:
+            type: object
+            properties:
+              CorrelId:
+                type: string
+                minLength: 24
+                maxLength: 24
+                format: binary
+          applicationInstanceId:
+            $ref: '#/components/schemas/applicationInstanceId'
+      payload:
+        $ref: '#/components/schemas/lightMeasuredPayload'
+  schemas:
+    lightMeasuredPayload:
+      type: object
+      properties:
+        lumens:
+          type: integer
+          minimum: 0
+          description: Light intensity measured in lumens.
+        sentAt:
+          $ref: '#/components/schemas/sentAt'
+    sentAt:
+      type: string
+      format: date-time
+      description: Date and time when the message was sent.
+    applicationInstanceId:
+      description: Unique identifier for a given instance of the publishing application
+      type: string
+  parameters:
+    streetlightId:
+      description: The ID of the streetlight.

package/assets/examples/correlation-id-asyncapi.yml

@@ -0,0 +1,180 @@
+asyncapi: 3.0.0
+info:
+  title: Correlation ID Example
+  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'
+defaultContentType: application/json
+servers:
+  production:
+    host: 'test.mosquitto.org:{port}'
+    protocol: mqtt
+    description: Test broker
+    variables:
+      port:
+        description: Secure connection (TLS) is available through port 8883.
+        default: '1883'
+        enum:
+          - '1883'
+          - '8883'
+    security:
+      - $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:
+  lightingMeasured:
+    address: 'smartylighting/streetlights/1/0/event/{streetlightId}/lighting/measured'
+    messages:
+      lightMeasured:
+        $ref: '#/components/messages/lightMeasured'
+    parameters:
+      streetlightId:
+        $ref: '#/components/parameters/streetlightId'
+  lightsDim:
+    address: 'smartylighting/streetlights/1/0/action/{streetlightId}/dim'
+    messages:
+      dimLight:
+        $ref: '#/components/messages/dimLight'
+    parameters:
+      streetlightId:
+        $ref: '#/components/parameters/streetlightId'
+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.
+      correlationId:
+        location: $message.header#/MQMD/CorrelId
+      contentType: application/json
+      payload:
+        $ref: '#/components/schemas/lightMeasuredPayload'
+    dimLight:
+      name: dimLight
+      title: Dim light
+      summary: Command a particular streetlight to dim the lights.
+      correlationId:
+        $ref: '#/components/correlationIds/sentAtCorrelator'
+      payload:
+        $ref: '#/components/schemas/dimLightPayload'
+  schemas:
+    lightMeasuredPayload:
+      type: object
+      properties:
+        lumens:
+          type: integer
+          minimum: 0
+          description: Light intensity measured in lumens.
+        sentAt:
+          $ref: '#/components/schemas/sentAt'
+    dimLightPayload:
+      type: object
+      properties:
+        percentage:
+          type: integer
+          description: Percentage to which the light should be dimmed to.
+          minimum: 0
+          maximum: 100
+        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.
+  correlationIds:
+    sentAtCorrelator:
+      description: Data from message payload used as correlation ID
+      location: $message.payload#/sentAt
+  securitySchemes:
+    apiKey:
+      type: apiKey
+      in: user
+      description: Provide your API key as the user and leave the password empty.
+    supportedOauthFlows:
+      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
+    openIdConnectWellKnown:
+      type: openIdConnect
+      openIdConnectUrl: 'https://authserver.example/.well-known'

package/assets/examples/default-example.json

@@ -0,0 +1,51 @@
+{
+    "asyncapi": "3.0.0",
+    "info": {
+      "title": "Account Service",
+      "version": "1.0.0",
+      "description": "This service is in charge of processing user signups"
+    },
+    "channels": {
+      "userSignedUp": {
+        "address": "user/signedup",
+        "messages": {
+          "UserSignedUp": {
+            "$ref": "#/components/messages/UserSignedUp"
+          }
+        }
+      }
+    },
+    "operations": {
+      "onUserSignUp": {
+        "action": "receive",
+        "channel": {
+          "$ref": "#/channels/userSignedUp"
+        },
+        "messages": [
+          {
+            "$ref": "#/channels/userSignedUp/messages/UserSignedUp"
+          }
+        ]
+      }
+    },
+    "components": {
+      "messages": {
+        "UserSignedUp": {
+          "payload": {
+            "type": "object",
+            "properties": {
+              "displayName": {
+                "type": "string",
+                "description": "Name of the user"
+              },
+              "email": {
+                "type": "string",
+                "format": "email",
+                "description": "Email of the user"
+              }
+            }
+          }
+        }
+      }
+    }
+  }