AWS2-SQS: Expose Kamelet data type information (#1640)

Signed-off-by: Andrea Cosentino <ancosen@gmail.com>
apache · Sep 18, 2023 · 1d63f32 · 1d63f32
1 parent 8311463
commit 1d63f32
Show file tree

Hide file tree

Showing 2 changed files with 118 additions and 0 deletions.
diff --git a/kamelets/aws-sqs-source.kamelet.yaml b/kamelets/aws-sqs-source.kamelet.yaml
@@ -139,6 +139,65 @@ spec:
         x-descriptors:
           - 'urn:alm:descriptor:com.tectonic.ui:checkbox'
         default: false
+  dataTypes:
+    out:
+      default: text
+      headers:
+        CamelAwsSqsMessageId:
+          title: The SQS Message Id
+          description: The Amazon SQS message ID
+          type: string
+        CamelAwsSqsReceiptHandle:
+          title: The SQS Message Receipt Handle
+          description: The Amazon SQS message receipt handle.
+          type: string
+        CamelAwsSqsMD5OfBody:
+          title: The SQS Message MD5 Checksum
+          description: The content type of the retrieved object.
+          default: application/octet-stream
+          type: string
+        CamelAwsSqsAttributes:
+          title: The SQS Message System Attributes
+          description: |-
+            A map of the attributes requested in ReceiveMessage to their respective values, the Map type is Map<MessageSystemAttributeName, String>
+          type: object
+        CamelAwsSqsMessageAttributes:
+          title: The SQS Message Attributes
+          description: |-
+            The Amazon SQS message attributes, the Map type is Map<String, MessageAttributeValue>
+          type: object
+      types:
+        text:
+          format: "text-plain"
+          description: Default String representation of the SQS message received from the queue.
+          mediaType: text/plain
+        cloudevents:
+          format: "aws2-sqs:application-cloudevents"
+          description: |-
+            Output data type represents AWS SQS receive message response as CloudEvent V1. The data type sets Camel specific CloudEvent headers on the exchange with
+            respective data from the SQS message and its derived object.
+          headers:
+            CamelCloudEventID:
+              title: CloudEvent ID
+              description: The Camel exchange id set as event id
+              type: string
+            CamelCloudEventType:
+              title: CloudEvent Type
+              description: The event type
+              default: "org.apache.camel.event.aws.sqs.receiveMessage"
+              type: string
+            CamelCloudEventSource:
+              title: CloudEvent Source
+              description: The event source. By default, the SQS Received message receipt handle with prefix "aws.sqs.queue.".
+              type: string
+            CamelCloudEventSubject:
+              title: CloudEvent Subject
+              description: The event subject. The SQS message ID
+              type: string
+            CamelCloudEventTime:
+              title: CloudEvent Time
+              description: The exchange creation timestamp as event time.
+              type: string
   dependencies:
     - "camel:core"
     - "camel:aws2-sqs"

diff --git a/library/camel-kamelets/src/main/resources/kamelets/aws-sqs-source.kamelet.yaml b/library/camel-kamelets/src/main/resources/kamelets/aws-sqs-source.kamelet.yaml
@@ -139,6 +139,65 @@ spec:
         x-descriptors:
           - 'urn:alm:descriptor:com.tectonic.ui:checkbox'
         default: false
+  dataTypes:
+    out:
+      default: text
+      headers:
+        CamelAwsSqsMessageId:
+          title: The SQS Message Id
+          description: The Amazon SQS message ID
+          type: string
+        CamelAwsSqsReceiptHandle:
+          title: The SQS Message Receipt Handle
+          description: The Amazon SQS message receipt handle.
+          type: string
+        CamelAwsSqsMD5OfBody:
+          title: The SQS Message MD5 Checksum
+          description: The content type of the retrieved object.
+          default: application/octet-stream
+          type: string
+        CamelAwsSqsAttributes:
+          title: The SQS Message System Attributes
+          description: |-
+            A map of the attributes requested in ReceiveMessage to their respective values, the Map type is Map<MessageSystemAttributeName, String>
+          type: object
+        CamelAwsSqsMessageAttributes:
+          title: The SQS Message Attributes
+          description: |-
+            The Amazon SQS message attributes, the Map type is Map<String, MessageAttributeValue>
+          type: object
+      types:
+        text:
+          format: "text-plain"
+          description: Default String representation of the SQS message received from the queue.
+          mediaType: text/plain
+        cloudevents:
+          format: "aws2-sqs:application-cloudevents"
+          description: |-
+            Output data type represents AWS SQS receive message response as CloudEvent V1. The data type sets Camel specific CloudEvent headers on the exchange with
+            respective data from the SQS message and its derived object.
+          headers:
+            CamelCloudEventID:
+              title: CloudEvent ID
+              description: The Camel exchange id set as event id
+              type: string
+            CamelCloudEventType:
+              title: CloudEvent Type
+              description: The event type
+              default: "org.apache.camel.event.aws.sqs.receiveMessage"
+              type: string
+            CamelCloudEventSource:
+              title: CloudEvent Source
+              description: The event source. By default, the SQS Received message receipt handle with prefix "aws.sqs.queue.".
+              type: string
+            CamelCloudEventSubject:
+              title: CloudEvent Subject
+              description: The event subject. The SQS message ID
+              type: string
+            CamelCloudEventTime:
+              title: CloudEvent Time
+              description: The exchange creation timestamp as event time.
+              type: string
   dependencies:
     - "camel:core"
     - "camel:aws2-sqs"