Google Mail Source: Expose Kamelet data type information (#2037)

Signed-off-by: Andrea Cosentino <ancosen@gmail.com>
apache · May 13, 2024 · d7bfa60 · d7bfa60
1 parent b00d457
commit d7bfa60
Show file tree

Hide file tree

Showing 2 changed files with 120 additions and 4 deletions.
diff --git a/kamelets/google-mail-source.kamelet.yaml b/kamelets/google-mail-source.kamelet.yaml
@@ -98,9 +98,67 @@ spec:
         type: string
         example: "is:unread -category:(promotions OR social)"
         default: "is:unread"
-  types:
+  dataTypes:
     out:
-      mediaType: application/json
+      default: json
+      headers:
+        CamelGoogleMailId:
+          title: Camel Google Mail Id
+          description: The ID of the message
+          type: string
+        CamelGoogleMailStreamTo:
+          title: Camel Google Mail To Address
+          description: The recipient of the message
+          type: string
+        CamelGoogleMailStreamFrom:
+          title: Camel Google Mail From Address
+          description: The emitter of the message
+          type: string
+        CamelGoogleMailStreamCc:
+          title: Camel Google Mail Cc
+          description: The carbon copy of the message
+          type: string
+        CamelGoogleMailStreamBcc:
+          title: Camel Google Mail Bcc
+          description: The blind carbon cpoy of the message
+          type: string
+        CamelGoogleMailStreamSubject:
+          title: Camel Google Mail Subject
+          description: The subject of the message
+          type: string
+      types:
+        json:
+          format: "application-json"
+          description: |-
+            Json representation of a Google Mail event object.
+          mediaType: application/json
+        cloudevents:
+          format: "google-mail-stream:application-cloudevents"
+          description: |-
+            Output data type represents Google Mail Streams response as CloudEvent V1. The data type sets Camel specific CloudEvent headers on the exchange with
+            respective data from the Mail 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.google.mail.stream.consume"
+              type: string
+            CamelCloudEventSource:
+              title: CloudEvent Source
+              description: The event source. By default, the Mail From with prefix "google.mail.stream.".
+              type: string
+            CamelCloudEventSubject:
+              title: CloudEvent Subject
+              description: The event subject. The Calendar event type.
+              type: string
+            CamelCloudEventTime:
+              title: CloudEvent Time
+              description: The exchange creation timestamp as event time.
+              type: string
   dependencies:
   - "camel:jackson"
   - "camel:kamelet"

diff --git a/library/camel-kamelets/src/main/resources/kamelets/google-mail-source.kamelet.yaml b/library/camel-kamelets/src/main/resources/kamelets/google-mail-source.kamelet.yaml
@@ -98,9 +98,67 @@ spec:
         type: string
         example: "is:unread -category:(promotions OR social)"
         default: "is:unread"
-  types:
+  dataTypes:
     out:
-      mediaType: application/json
+      default: json
+      headers:
+        CamelGoogleMailId:
+          title: Camel Google Mail Id
+          description: The ID of the message
+          type: string
+        CamelGoogleMailStreamTo:
+          title: Camel Google Mail To Address
+          description: The recipient of the message
+          type: string
+        CamelGoogleMailStreamFrom:
+          title: Camel Google Mail From Address
+          description: The emitter of the message
+          type: string
+        CamelGoogleMailStreamCc:
+          title: Camel Google Mail Cc
+          description: The carbon copy of the message
+          type: string
+        CamelGoogleMailStreamBcc:
+          title: Camel Google Mail Bcc
+          description: The blind carbon cpoy of the message
+          type: string
+        CamelGoogleMailStreamSubject:
+          title: Camel Google Mail Subject
+          description: The subject of the message
+          type: string
+      types:
+        json:
+          format: "application-json"
+          description: |-
+            Json representation of a Google Mail event object.
+          mediaType: application/json
+        cloudevents:
+          format: "google-mail-stream:application-cloudevents"
+          description: |-
+            Output data type represents Google Mail Streams response as CloudEvent V1. The data type sets Camel specific CloudEvent headers on the exchange with
+            respective data from the Mail 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.google.mail.stream.consume"
+              type: string
+            CamelCloudEventSource:
+              title: CloudEvent Source
+              description: The event source. By default, the Mail From with prefix "google.mail.stream.".
+              type: string
+            CamelCloudEventSubject:
+              title: CloudEvent Subject
+              description: The event subject. The Calendar event type.
+              type: string
+            CamelCloudEventTime:
+              title: CloudEvent Time
+              description: The exchange creation timestamp as event time.
+              type: string
   dependencies:
   - "camel:jackson"
   - "camel:kamelet"