From c181fb42b72172dc3fcae85f6786fcb6d6153281 Mon Sep 17 00:00:00 2001 From: Joe Reuter Date: Mon, 16 Oct 2023 18:29:01 +0200 Subject: [PATCH] fix: Add more documentation to analytics message (#46) --- .../main/resources/airbyte_protocol/airbyte_protocol.yaml | 5 +++-- .../main/resources/airbyte_protocol/v0/airbyte_protocol.yaml | 5 +++-- 2 files changed, 6 insertions(+), 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 index 692414d..a465bcb 100644 --- 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 index ebe3e0e..e17fc0f 100644 --- 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