Update HTTPAPIBudget description

airbytehq · Feb 11, 2025 · 245fb3e · 245fb3e
1 parent ba8a735
commit 245fb3e
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 16 deletions.
diff --git a/airbyte_cdk/sources/declarative/declarative_component_schema.yaml b/airbyte_cdk/sources/declarative/declarative_component_schema.yaml
@@ -41,10 +41,7 @@ properties:
   concurrency_level:
     "$ref": "#/definitions/ConcurrencyLevel"
   api_budget:
-    title: API Budget
-    description: Defines how many requests can be made to the API in a given time frame. This field accepts either a generic APIBudget or an HTTP-specific configuration (HTTPAPIBudget) to be applied across all streams.
-    anyOf:
-      - "$ref": "#/definitions/HTTPAPIBudget"
+    "$ref": "#/definitions/HTTPAPIBudget"
   metadata:
     type: object
     description: For internal Airbyte use only - DO NOT modify manually. Used by consumers of declarative manifests for storing related metadata.
@@ -1373,8 +1370,10 @@ definitions:
   HTTPAPIBudget:
     title: HTTP API Budget
     description: >
-      An HTTP-specific API budget that extends APIBudget by updating rate limiting information based
-      on HTTP response headers. It extracts available calls and the next reset timestamp from the HTTP responses.
+      Defines how many requests can be made to the API in a given time frame. `HTTPAPIBudget` extracts the remaining
+      call count and the reset time from HTTP response headers using the header names provided by
+      `ratelimit_remaining_header` and `ratelimit_reset_header`. Only requests using `HttpRequester`
+      are rate-limited; custom components that bypass `HttpRequester` are not covered by this budget.
     type: object
     required:
       - type

diff --git a/airbyte_cdk/sources/declarative/models/declarative_component_schema.py b/airbyte_cdk/sources/declarative/models/declarative_component_schema.py
@@ -1873,11 +1873,7 @@ class Config:
     definitions: Optional[Dict[str, Any]] = None
     spec: Optional[Spec] = None
     concurrency_level: Optional[ConcurrencyLevel] = None
-    api_budget: Optional[HTTPAPIBudget] = Field(
-        None,
-        description="Defines how many requests can be made to the API in a given time frame. This field accepts either a generic APIBudget or an HTTP-specific configuration (HTTPAPIBudget) to be applied across all streams.",
-        title="API Budget",
-    )
+    api_budget: Optional[HTTPAPIBudget] = None
     metadata: Optional[Dict[str, Any]] = Field(
         None,
         description="For internal Airbyte use only - DO NOT modify manually. Used by consumers of declarative manifests for storing related metadata.",
@@ -1904,11 +1900,7 @@ class Config:
     definitions: Optional[Dict[str, Any]] = None
     spec: Optional[Spec] = None
     concurrency_level: Optional[ConcurrencyLevel] = None
-    api_budget: Optional[HTTPAPIBudget] = Field(
-        None,
-        description="Defines how many requests can be made to the API in a given time frame. This field accepts either a generic APIBudget or an HTTP-specific configuration (HTTPAPIBudget) to be applied across all streams.",
-        title="API Budget",
-    )
+    api_budget: Optional[HTTPAPIBudget] = None
     metadata: Optional[Dict[str, Any]] = Field(
         None,
         description="For internal Airbyte use only - DO NOT modify manually. Used by consumers of declarative manifests for storing related metadata.",