feat: add reasons to AirbyteStreamStatusTraceMessage (#74)

airbytehq · May 16, 2024 · fe0ada2 · fe0ada2
1 parent 6aa42fe
commit fe0ada2
Show file tree

Hide file tree

Showing 2 changed files with 62 additions and 0 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
@@ -239,6 +239,7 @@ definitions:
           - ANALYTICS
       emitted_at:
         description: "the time in ms that the message was emitted"
+        # TODO : This should have been an integer instead of a number, need to fix this
         type: number
       error:
         description: "error trace message: the error object"
@@ -315,6 +316,30 @@ definitions:
       - RUNNING # Stream has read its first byte/message
       - COMPLETE # Stream has completed executing without interruption or error
       - INCOMPLETE # Stream has stopped due to an interruption or error
+  AirbyteStreamStatusReasonType:
+    type: string
+    description: >
+      Type of reason
+    enum:
+      - RATE_LIMITED
+  AirbyteStreamStatusRateLimitedReason:
+    type: object
+    description: Rate Limited Information
+    properties:
+      quota_reset:
+        description: "Optional time in ms representing when the API quota is going to be reset"
+        type: integer
+  AirbyteStreamStatusReason:
+    type: object
+    required:
+      - type
+    description: >
+      The reason associated with the status of the stream.
+    properties:
+      type:
+        "$ref": "#/definitions/AirbyteStreamStatusReasonType"
+      rate_limited:
+        "$ref": "#/definitions/AirbyteStreamStatusRateLimitedReason"
   AirbyteStreamStatusTraceMessage:
     type: object
     additionalProperties: true
@@ -328,6 +353,11 @@ definitions:
       status:
         description: "The current status of the stream"
         "$ref": "#/definitions/AirbyteStreamStatus"
+      reasons:
+        description: "The reasons associated with the status of the stream"
+        type: array
+        items:
+          "$ref": "#/definitions/AirbyteStreamStatusReason"
   AirbyteAnalyticsTraceMessage:
     type: object
     additionalProperties: true
@@ -367,6 +397,7 @@ definitions:
           - CONNECTOR_CONFIG
       emitted_at:
         description: "the time in ms that the message was emitted"
+        # TODO : This should have been an integer instead of a number, need to fix this
         type: number
       connectorConfig:
         description: "connector config orchestrator message: the updated config for the platform to store for this connector"

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
@@ -239,6 +239,7 @@ definitions:
           - STREAM_STATUS
           - ANALYTICS
       emitted_at:
+        # TODO : This should have been an integer instead of a number, need to fix this
         description: "the time in ms that the message was emitted"
         type: number
       error:
@@ -316,6 +317,30 @@ definitions:
       - RUNNING # Stream has read its first byte/message
       - COMPLETE # Stream has completed executing without interruption or error
       - INCOMPLETE # Stream has stopped due to an interruption or error
+  AirbyteStreamStatusReasonType:
+    type: string
+    description: >
+      Type of reason
+    enum:
+      - RATE_LIMITED
+  AirbyteStreamStatusRateLimitedReason:
+    type: object
+    description: Rate Limited Information
+    properties:
+      quota_reset:
+        description: "Optional time in ms representing when the API quota is going to be reset"
+        type: integer
+  AirbyteStreamStatusReason:
+    type: object
+    required:
+      - type
+    description: >
+      The reason associated with the status of the stream.
+    properties:
+      type:
+        "$ref": "#/definitions/AirbyteStreamStatusReasonType"
+      rate_limited:
+        "$ref": "#/definitions/AirbyteStreamStatusRateLimitedReason"
   AirbyteStreamStatusTraceMessage:
     type: object
     additionalProperties: true
@@ -329,6 +354,11 @@ definitions:
       status:
         description: "The current status of the stream"
         "$ref": "#/definitions/AirbyteStreamStatus"
+      reasons:
+        description: "The reasons associated with the status of the stream"
+        type: array
+        items:
+          "$ref": "#/definitions/AirbyteStreamStatusReason"
   AirbyteAnalyticsTraceMessage:
     type: object
     additionalProperties: true
@@ -368,6 +398,7 @@ definitions:
           - CONNECTOR_CONFIG
       emitted_at:
         description: "the time in ms that the message was emitted"
+        # TODO : This should have been an integer instead of a number, need to fix this
         type: number
       connectorConfig:
         description: "connector config orchestrator message: the updated config for the platform to store for this connector"