Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Add more documentation to analytics message #46

Merged
merged 2 commits into from
Oct 16, 2023
Merged

fix: Add more documentation to analytics message #46

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1e26160
add more documentation
Oct 16, 2023
68ee26b
review comment
Oct 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions protocol-models/src/main/resources/airbyte_protocol/airbyte_protocol.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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."
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't these same changes be applied to the V0 file as well?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

They absolutely should be, adjusted. Thanks for noticing!

AirbyteControlMessage:
type: object
additionalProperties: true
Expand Down
5 changes: 3 additions & 2 deletions protocol-models/src/main/resources/airbyte_protocol/v0/airbyte_protocol.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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
Expand Down