fix: Add more documentation to analytics message (#46)

airbytehq · Oct 16, 2023 · c181fb4 · c181fb4
1 parent 2c011ff
commit c181fb4
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 4 deletions.
diff --git a/protocol-models/src/main/resources/airbyte_protocol/airbyte_protocol.yaml b/protocol-models/src/main/resources/airbyte_protocol/airbyte_protocol.yaml
@@ -272,6 +272,7 @@ definitions:
     additionalProperties: true
     description:
       "A message to communicate usage information about the connector which is not captured by regular sync analytics because it's specific to the connector internals.
+
       This is useful to understand how the connector is used and how to improve it.
       Each message is an event with a type and an optional payload value (both of them being strings). The event types should not be dynamically generated but defined statically.
       The payload value is optional and can contain arbitrary strings.
@@ -285,11 +286,11 @@ definitions:
       - type
     properties:
       type:
-        description: "the event type"
+        description: "The event type - should be a static string. Keep in mind that all strings are shared across all connectors."
         type: string
       value:
         type: string
-        description: "the value of the event"
+        description: "The value of the event - can be an arbitrary string. In case the value is numeric, it should be converted to a string. Casting for analytics purposes can happen in the warehouse."
   AirbyteControlMessage:
     type: object
     additionalProperties: true

diff --git a/protocol-models/src/main/resources/airbyte_protocol/v0/airbyte_protocol.yaml b/protocol-models/src/main/resources/airbyte_protocol/v0/airbyte_protocol.yaml
@@ -267,6 +267,7 @@ definitions:
     additionalProperties: true
     description:
       "A message to communicate usage information about the connector which is not captured by regular sync analytics because it's specific to the connector internals.
+
       This is useful to understand how the connector is used and how to improve it.
       Each message is an event with a type and an optional payload value (both of them being strings). The event types should not be dynamically generated but defined statically.
       The payload value is optional and can contain arbitrary strings.
@@ -280,11 +281,11 @@ definitions:
       - type
     properties:
       type:
-        description: "the event type"
+        description: "The event type - should be a static string. Keep in mind that all strings are shared across all connectors."
         type: string
       value:
         type: string
-        description: "the value of the event"
+        description: "The value of the event - can be an arbitrary string. In case the value is numeric, it should be converted to a string. Casting for analytics purposes can happen in the warehouse."
   AirbyteControlMessage:
     type: object
     additionalProperties: true