airbyte-agent-shopify 0.1.16__tar.gz → 0.1.23__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (62) hide show
  1. {airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.23}/AUTH.md +19 -4
  2. {airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.23}/CHANGELOG.md +35 -0
  3. {airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.23}/PKG-INFO +13 -9
  4. {airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.23}/README.md +12 -8
  5. {airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.23}/REFERENCE.md +0 -1
  6. {airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.23}/airbyte_agent_shopify/__init__.py +8 -6
  7. {airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.23}/airbyte_agent_shopify/_vendored/connector_sdk/connector_model_loader.py +4 -0
  8. {airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.23}/airbyte_agent_shopify/_vendored/connector_sdk/executor/hosted_executor.py +5 -0
  9. {airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.23}/airbyte_agent_shopify/_vendored/connector_sdk/executor/local_executor.py +82 -0
  10. {airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.23}/airbyte_agent_shopify/_vendored/connector_sdk/executor/models.py +12 -0
  11. {airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.23}/airbyte_agent_shopify/_vendored/connector_sdk/http/adapters/httpx_adapter.py +10 -1
  12. {airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.23}/airbyte_agent_shopify/_vendored/connector_sdk/introspection.py +12 -5
  13. {airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.23}/airbyte_agent_shopify/_vendored/connector_sdk/schema/base.py +11 -0
  14. {airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.23}/airbyte_agent_shopify/_vendored/connector_sdk/schema/operations.py +10 -0
  15. {airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.23}/airbyte_agent_shopify/_vendored/connector_sdk/telemetry/tracker.py +4 -4
  16. {airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.23}/airbyte_agent_shopify/_vendored/connector_sdk/types.py +16 -1
  17. {airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.23}/airbyte_agent_shopify/_vendored/connector_sdk/validation.py +42 -1
  18. airbyte_agent_shopify-0.1.23/airbyte_agent_shopify/_vendored/connector_sdk/validation_replication.py +970 -0
  19. {airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.23}/airbyte_agent_shopify/connector.py +42 -2
  20. {airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.23}/airbyte_agent_shopify/connector_model.py +2 -1
  21. {airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.23}/airbyte_agent_shopify/models.py +84 -65
  22. {airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.23}/pyproject.toml +1 -1
  23. {airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.23}/.gitignore +0 -0
  24. {airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.23}/airbyte_agent_shopify/_vendored/__init__.py +0 -0
  25. {airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.23}/airbyte_agent_shopify/_vendored/connector_sdk/__init__.py +0 -0
  26. {airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.23}/airbyte_agent_shopify/_vendored/connector_sdk/auth_strategies.py +0 -0
  27. {airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.23}/airbyte_agent_shopify/_vendored/connector_sdk/auth_template.py +0 -0
  28. {airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.23}/airbyte_agent_shopify/_vendored/connector_sdk/cloud_utils/__init__.py +0 -0
  29. {airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.23}/airbyte_agent_shopify/_vendored/connector_sdk/cloud_utils/client.py +0 -0
  30. {airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.23}/airbyte_agent_shopify/_vendored/connector_sdk/constants.py +0 -0
  31. {airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.23}/airbyte_agent_shopify/_vendored/connector_sdk/exceptions.py +0 -0
  32. {airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.23}/airbyte_agent_shopify/_vendored/connector_sdk/executor/__init__.py +0 -0
  33. {airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.23}/airbyte_agent_shopify/_vendored/connector_sdk/extensions.py +0 -0
  34. {airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.23}/airbyte_agent_shopify/_vendored/connector_sdk/http/__init__.py +0 -0
  35. {airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.23}/airbyte_agent_shopify/_vendored/connector_sdk/http/adapters/__init__.py +0 -0
  36. {airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.23}/airbyte_agent_shopify/_vendored/connector_sdk/http/config.py +0 -0
  37. {airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.23}/airbyte_agent_shopify/_vendored/connector_sdk/http/exceptions.py +0 -0
  38. {airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.23}/airbyte_agent_shopify/_vendored/connector_sdk/http/protocols.py +0 -0
  39. {airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.23}/airbyte_agent_shopify/_vendored/connector_sdk/http/response.py +0 -0
  40. {airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.23}/airbyte_agent_shopify/_vendored/connector_sdk/http_client.py +0 -0
  41. {airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.23}/airbyte_agent_shopify/_vendored/connector_sdk/logging/__init__.py +0 -0
  42. {airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.23}/airbyte_agent_shopify/_vendored/connector_sdk/logging/logger.py +0 -0
  43. {airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.23}/airbyte_agent_shopify/_vendored/connector_sdk/logging/types.py +0 -0
  44. {airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.23}/airbyte_agent_shopify/_vendored/connector_sdk/observability/__init__.py +0 -0
  45. {airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.23}/airbyte_agent_shopify/_vendored/connector_sdk/observability/config.py +0 -0
  46. {airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.23}/airbyte_agent_shopify/_vendored/connector_sdk/observability/models.py +0 -0
  47. {airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.23}/airbyte_agent_shopify/_vendored/connector_sdk/observability/redactor.py +0 -0
  48. {airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.23}/airbyte_agent_shopify/_vendored/connector_sdk/observability/session.py +0 -0
  49. {airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.23}/airbyte_agent_shopify/_vendored/connector_sdk/performance/__init__.py +0 -0
  50. {airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.23}/airbyte_agent_shopify/_vendored/connector_sdk/performance/instrumentation.py +0 -0
  51. {airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.23}/airbyte_agent_shopify/_vendored/connector_sdk/performance/metrics.py +0 -0
  52. {airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.23}/airbyte_agent_shopify/_vendored/connector_sdk/schema/__init__.py +0 -0
  53. {airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.23}/airbyte_agent_shopify/_vendored/connector_sdk/schema/components.py +0 -0
  54. {airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.23}/airbyte_agent_shopify/_vendored/connector_sdk/schema/connector.py +0 -0
  55. {airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.23}/airbyte_agent_shopify/_vendored/connector_sdk/schema/extensions.py +0 -0
  56. {airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.23}/airbyte_agent_shopify/_vendored/connector_sdk/schema/security.py +0 -0
  57. {airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.23}/airbyte_agent_shopify/_vendored/connector_sdk/secrets.py +0 -0
  58. {airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.23}/airbyte_agent_shopify/_vendored/connector_sdk/telemetry/__init__.py +0 -0
  59. {airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.23}/airbyte_agent_shopify/_vendored/connector_sdk/telemetry/config.py +0 -0
  60. {airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.23}/airbyte_agent_shopify/_vendored/connector_sdk/telemetry/events.py +0 -0
  61. {airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.23}/airbyte_agent_shopify/_vendored/connector_sdk/utils.py +0 -0
  62. {airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.23}/airbyte_agent_shopify/types.py +0 -0
@@ -13,11 +13,15 @@ This authentication method isn't available for this connector.
13
13
 
14
14
  #### Token
15
15
 
16
+ `credentials` fields you need:
17
+
16
18
  | Field Name | Type | Required | Description |
17
19
  |------------|------|----------|-------------|
18
20
  | `api_key` | `str` | Yes | Your Shopify Admin API access token |
19
21
  | `shop` | `str` | Yes | Your Shopify store name (e.g., 'my-store' from my-store.myshopify.com) |
20
22
 
23
+ Example request:
24
+
21
25
  ```python
22
26
  from airbyte_agent_shopify import ShopifyConnector
23
27
  from airbyte_agent_shopify.models import ShopifyAuthConfig
@@ -38,16 +42,27 @@ In hosted mode, you first create a connector via the Airbyte API (providing your
38
42
  This authentication method isn't available for this connector.
39
43
 
40
44
  #### Token
45
+ Create a connector with Token credentials.
46
+
47
+
48
+ `credentials` fields you need:
49
+
50
+ | Field Name | Type | Required | Description |
51
+ |------------|------|----------|-------------|
52
+ | `api_key` | `str` | Yes | Your Shopify Admin API access token |
53
+ | `shop` | `str` | Yes | Your Shopify store name (e.g., 'my-store' from my-store.myshopify.com) |
54
+
55
+ Example request:
41
56
 
42
- Create a connector with Token credentials:
43
57
 
44
58
  ```bash
45
- curl -X POST 'https://api.airbyte.ai/v1/integrations/connectors' \
46
- -H 'Authorization: Bearer <SCOPED_TOKEN>' \
47
- -H 'Content-Type: application/json' \
59
+ curl -X POST "https://api.airbyte.ai/v1/integrations/connectors" \
60
+ -H "Authorization: Bearer <SCOPED_TOKEN>" \
61
+ -H "Content-Type: application/json" \
48
62
  -d '{
49
63
  "external_user_id": "<EXTERNAL_USER_ID>",
50
64
  "connector_type": "Shopify",
65
+ "name": "My Shopify Connector",
51
66
  "credentials": {
52
67
  "api_key": "<Your Shopify Admin API access token>",
53
68
  "shop": "<Your Shopify store name (e.g., 'my-store' from my-store.myshopify.com)>"
@@ -1,5 +1,40 @@
1
1
  # Shopify changelog
2
2
 
3
+ ## [0.1.23] - 2026-01-30
4
+ - Updated connector definition (YAML version 0.1.3)
5
+ - Source commit: 5f65d643
6
+ - SDK version: 0.1.0
7
+
8
+ ## [0.1.22] - 2026-01-30
9
+ - Updated connector definition (YAML version 0.1.2)
10
+ - Source commit: 5b20f488
11
+ - SDK version: 0.1.0
12
+
13
+ ## [0.1.21] - 2026-01-30
14
+ - Updated connector definition (YAML version 0.1.2)
15
+ - Source commit: a3729d85
16
+ - SDK version: 0.1.0
17
+
18
+ ## [0.1.20] - 2026-01-29
19
+ - Updated connector definition (YAML version 0.1.2)
20
+ - Source commit: 43200eed
21
+ - SDK version: 0.1.0
22
+
23
+ ## [0.1.19] - 2026-01-29
24
+ - Updated connector definition (YAML version 0.1.2)
25
+ - Source commit: c718c683
26
+ - SDK version: 0.1.0
27
+
28
+ ## [0.1.18] - 2026-01-28
29
+ - Updated connector definition (YAML version 0.1.2)
30
+ - Source commit: 97007bbd
31
+ - SDK version: 0.1.0
32
+
33
+ ## [0.1.17] - 2026-01-28
34
+ - Updated connector definition (YAML version 0.1.2)
35
+ - Source commit: f6c6fca2
36
+ - SDK version: 0.1.0
37
+
3
38
  ## [0.1.16] - 2026-01-28
4
39
  - Updated connector definition (YAML version 0.1.2)
5
40
  - Source commit: 71f48c10
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: airbyte-agent-shopify
3
- Version: 0.1.16
3
+ Version: 0.1.23
4
4
  Summary: Airbyte Shopify Connector for AI platforms
5
5
  Project-URL: Homepage, https://github.com/airbytehq/airbyte-agent-connectors
6
6
  Project-URL: Documentation, https://docs.airbyte.com/ai-agents/
@@ -119,10 +119,11 @@ async def shopify_execute(entity: str, action: str, params: dict | None = None):
119
119
  return await connector.execute(entity, action, params or {})
120
120
  ```
121
121
 
122
-
123
122
  ## Full documentation
124
123
 
125
- This connector supports the following entities and actions.
124
+ ### Entities and actions
125
+
126
+ This connector supports the following entities and actions. For more details, see this connector's [full reference documentation](REFERENCE.md).
126
127
 
127
128
  | Entity | Actions |
128
129
  |--------|---------|
@@ -160,14 +161,17 @@ This connector supports the following entities and actions.
160
161
  | Fulfillment Orders | [List](./REFERENCE.md#fulfillment-orders-list), [Get](./REFERENCE.md#fulfillment-orders-get) |
161
162
 
162
163
 
163
- For all authentication options, see the connector's [authentication documentation](AUTH.md).
164
+ ### Authentication and configuration
165
+
166
+ For all authentication and configuration options, see the connector's [authentication documentation](AUTH.md).
164
167
 
165
- For detailed documentation on available actions and parameters, see this connector's [full reference documentation](./REFERENCE.md).
168
+ ### Shopify API docs
166
169
 
167
- For the service's official API docs, see the [Shopify API reference](https://shopify.dev/docs/api/admin-rest).
170
+ See the official [Shopify API reference](https://shopify.dev/docs/api/admin-rest).
168
171
 
169
172
  ## Version information
170
173
 
171
- - **Package version:** 0.1.16
172
- - **Connector version:** 0.1.2
173
- - **Generated with Connector SDK commit SHA:** 71f48c102ce98c9298e5102761e740f0d97eb71b
174
+ - **Package version:** 0.1.23
175
+ - **Connector version:** 0.1.3
176
+ - **Generated with Connector SDK commit SHA:** 580ea1221eff062f41b1065a155124c85861cb18
177
+ - **Changelog:** [View changelog](https://github.com/airbytehq/airbyte-agent-connectors/blob/main/connectors/shopify/CHANGELOG.md)
@@ -86,10 +86,11 @@ async def shopify_execute(entity: str, action: str, params: dict | None = None):
86
86
  return await connector.execute(entity, action, params or {})
87
87
  ```
88
88
 
89
-
90
89
  ## Full documentation
91
90
 
92
- This connector supports the following entities and actions.
91
+ ### Entities and actions
92
+
93
+ This connector supports the following entities and actions. For more details, see this connector's [full reference documentation](REFERENCE.md).
93
94
 
94
95
  | Entity | Actions |
95
96
  |--------|---------|
@@ -127,14 +128,17 @@ This connector supports the following entities and actions.
127
128
  | Fulfillment Orders | [List](./REFERENCE.md#fulfillment-orders-list), [Get](./REFERENCE.md#fulfillment-orders-get) |
128
129
 
129
130
 
130
- For all authentication options, see the connector's [authentication documentation](AUTH.md).
131
+ ### Authentication and configuration
132
+
133
+ For all authentication and configuration options, see the connector's [authentication documentation](AUTH.md).
131
134
 
132
- For detailed documentation on available actions and parameters, see this connector's [full reference documentation](./REFERENCE.md).
135
+ ### Shopify API docs
133
136
 
134
- For the service's official API docs, see the [Shopify API reference](https://shopify.dev/docs/api/admin-rest).
137
+ See the official [Shopify API reference](https://shopify.dev/docs/api/admin-rest).
135
138
 
136
139
  ## Version information
137
140
 
138
- - **Package version:** 0.1.16
139
- - **Connector version:** 0.1.2
140
- - **Generated with Connector SDK commit SHA:** 71f48c102ce98c9298e5102761e740f0d97eb71b
141
+ - **Package version:** 0.1.23
142
+ - **Connector version:** 0.1.3
143
+ - **Generated with Connector SDK commit SHA:** 580ea1221eff062f41b1065a155124c85861cb18
144
+ - **Changelog:** [View changelog](https://github.com/airbytehq/airbyte-agent-connectors/blob/main/connectors/shopify/CHANGELOG.md)
@@ -4292,4 +4292,3 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/sources/{your_source_i
4292
4292
 
4293
4293
  </details>
4294
4294
 
4295
-
@@ -13,14 +13,14 @@ from .models import (
13
13
  CustomerAddressList,
14
14
  MarketingConsent,
15
15
  OrderAddress,
16
- LineItem,
17
- Fulfillment,
18
16
  Transaction,
19
17
  Refund,
18
+ LineItem,
19
+ Fulfillment,
20
20
  Order,
21
21
  OrderList,
22
- ProductVariant,
23
22
  ProductImage,
23
+ ProductVariant,
24
24
  Product,
25
25
  ProductList,
26
26
  ProductVariantList,
@@ -88,6 +88,7 @@ from .models import (
88
88
  MetafieldProductImagesListResultMeta,
89
89
  CustomerAddressListResultMeta,
90
90
  FulfillmentOrdersListResultMeta,
91
+ ShopifyCheckResult,
91
92
  ShopifyExecuteResult,
92
93
  ShopifyExecuteResultWithMeta,
93
94
  CustomersListResult,
@@ -186,14 +187,14 @@ __all__ = [
186
187
  "CustomerAddressList",
187
188
  "MarketingConsent",
188
189
  "OrderAddress",
189
- "LineItem",
190
- "Fulfillment",
191
190
  "Transaction",
192
191
  "Refund",
192
+ "LineItem",
193
+ "Fulfillment",
193
194
  "Order",
194
195
  "OrderList",
195
- "ProductVariant",
196
196
  "ProductImage",
197
+ "ProductVariant",
197
198
  "Product",
198
199
  "ProductList",
199
200
  "ProductVariantList",
@@ -261,6 +262,7 @@ __all__ = [
261
262
  "MetafieldProductImagesListResultMeta",
262
263
  "CustomerAddressListResultMeta",
263
264
  "FulfillmentOrdersListResultMeta",
265
+ "ShopifyCheckResult",
264
266
  "ShopifyExecuteResult",
265
267
  "ShopifyExecuteResultWithMeta",
266
268
  "CustomersListResult",
@@ -496,6 +496,9 @@ def convert_openapi_to_connector_model(spec: OpenAPIConnector) -> ConnectorModel
496
496
  # Extract untested flag
497
497
  untested = getattr(operation, "x_airbyte_untested", None) or False
498
498
 
499
+ # Extract preferred_for_check flag
500
+ preferred_for_check = getattr(operation, "x_airbyte_preferred_for_check", None) or False
501
+
499
502
  # Create endpoint definition
500
503
  endpoint = EndpointDefinition(
501
504
  method=method_name.upper(),
@@ -520,6 +523,7 @@ def convert_openapi_to_connector_model(spec: OpenAPIConnector) -> ConnectorModel
520
523
  graphql_body=graphql_body,
521
524
  file_field=file_field,
522
525
  untested=untested,
526
+ preferred_for_check=preferred_for_check,
523
527
  )
524
528
 
525
529
  # Add to entities map
@@ -164,6 +164,11 @@ class HostedExecutor:
164
164
  span.record_exception(e)
165
165
  raise
166
166
 
167
+ async def check(self) -> ExecutionResult:
168
+ """Perform a health check via the cloud API."""
169
+ config = ExecutionConfig(entity="*", action="check", params={})
170
+ return await self.execute(config)
171
+
167
172
  def _parse_execution_result(self, response: dict) -> ExecutionResult:
168
173
  """Parse API response into ExecutionResult.
169
174
 
@@ -70,6 +70,14 @@ class _OperationContext:
70
70
  self.validate_required_body_fields = executor._validate_required_body_fields
71
71
  self.extract_records = executor._extract_records
72
72
 
73
+ @property
74
+ def standard_handler(self) -> _StandardOperationHandler | None:
75
+ """Return the standard operation handler, or None if not registered."""
76
+ for h in self.executor._operation_handlers:
77
+ if isinstance(h, _StandardOperationHandler):
78
+ return h
79
+ return None
80
+
73
81
 
74
82
  class _OperationHandler(Protocol):
75
83
  """Protocol for operation handlers."""
@@ -544,6 +552,80 @@ class LocalExecutor:
544
552
  # These are "expected" execution errors - return them in ExecutionResult
545
553
  return ExecutionResult(success=False, data={}, error=str(e))
546
554
 
555
+ async def check(self) -> ExecutionResult:
556
+ """Perform a health check by running a lightweight list operation.
557
+
558
+ Finds the operation marked with preferred_for_check=True, or falls back
559
+ to the first list operation. Executes it with limit=1 to verify
560
+ connectivity and credentials.
561
+
562
+ Returns:
563
+ ExecutionResult with data containing status, error, and checked operation details.
564
+ """
565
+ check_entity = None
566
+ check_endpoint = None
567
+
568
+ # Look for preferred check operation
569
+ for (ent_name, op_action), endpoint in self._operation_index.items():
570
+ if getattr(endpoint, "preferred_for_check", False):
571
+ check_entity = ent_name
572
+ check_endpoint = endpoint
573
+ break
574
+
575
+ # Fallback to first list operation
576
+ if check_endpoint is None:
577
+ for (ent_name, op_action), endpoint in self._operation_index.items():
578
+ if op_action == Action.LIST:
579
+ check_entity = ent_name
580
+ check_endpoint = endpoint
581
+ break
582
+
583
+ if check_endpoint is None or check_entity is None:
584
+ return ExecutionResult(
585
+ success=True,
586
+ data={
587
+ "status": "skipped",
588
+ "error": "No list operation available for health check",
589
+ },
590
+ )
591
+
592
+ # Find the standard handler to execute the list operation
593
+ standard_handler = next(
594
+ (h for h in self._operation_handlers if isinstance(h, _StandardOperationHandler)),
595
+ None,
596
+ )
597
+
598
+ if standard_handler is None:
599
+ return ExecutionResult(
600
+ success=True,
601
+ data={
602
+ "status": "skipped",
603
+ "error": "No standard handler available",
604
+ },
605
+ )
606
+
607
+ try:
608
+ await standard_handler.execute_operation(check_entity, Action.LIST, {"limit": 1})
609
+ return ExecutionResult(
610
+ success=True,
611
+ data={
612
+ "status": "healthy",
613
+ "checked_entity": check_entity,
614
+ "checked_action": "list",
615
+ },
616
+ )
617
+ except Exception as e:
618
+ return ExecutionResult(
619
+ success=False,
620
+ data={
621
+ "status": "unhealthy",
622
+ "error": str(e),
623
+ "checked_entity": check_entity,
624
+ "checked_action": "list",
625
+ },
626
+ error=str(e),
627
+ )
628
+
547
629
  async def _execute_operation(
548
630
  self,
549
631
  entity: str,
@@ -154,6 +154,18 @@ class ExecutorProtocol(Protocol):
154
154
  """
155
155
  ...
156
156
 
157
+ async def check(self) -> ExecutionResult:
158
+ """Perform a health check to verify connectivity and credentials.
159
+
160
+ Returns:
161
+ ExecutionResult with data containing:
162
+ - status: "healthy" or "unhealthy"
163
+ - error: Error message if unhealthy
164
+ - checked_entity: Entity used for the check
165
+ - checked_action: Action used for the check
166
+ """
167
+ ...
168
+
157
169
 
158
170
  # ============================================================================
159
171
  # Executor Exceptions
@@ -186,7 +186,16 @@ class HTTPXClient:
186
186
  # Try to get error message from response
187
187
  try:
188
188
  error_data = httpx_response.json()
189
- error_message = error_data.get("message") or error_data.get("error") or str(error_data)
189
+ errors_list = error_data.get("errors")
190
+ if isinstance(errors_list, list):
191
+
192
+ def _extract_error(e: object) -> str:
193
+ if isinstance(e, dict):
194
+ return str(e.get("userPresentableMessage") or e.get("message") or e.get("error") or e)
195
+ return str(e)
196
+
197
+ errors_list = ", ".join(_extract_error(e) for e in errors_list)
198
+ error_message = errors_list or error_data.get("message") or error_data.get("error") or str(error_data)
190
199
  except Exception:
191
200
  error_message = httpx_response.text or f"HTTP {status_code} error"
192
201
 
@@ -380,7 +380,11 @@ def describe_entities(model: ConnectorModelProtocol) -> list[dict[str, Any]]:
380
380
  return entities
381
381
 
382
382
 
383
- def generate_tool_description(model: ConnectorModelProtocol) -> str:
383
+ def generate_tool_description(
384
+ model: ConnectorModelProtocol,
385
+ *,
386
+ enable_hosted_mode_features: bool = True,
387
+ ) -> str:
384
388
  """Generate AI tool description from connector metadata.
385
389
 
386
390
  Produces a detailed description that includes:
@@ -393,6 +397,7 @@ def generate_tool_description(model: ConnectorModelProtocol) -> str:
393
397
 
394
398
  Args:
395
399
  model: Object conforming to ConnectorModelProtocol (e.g., ConnectorModel)
400
+ enable_hosted_mode_features: When False, omit hosted-mode search guidance from the docstring.
396
401
 
397
402
  Returns:
398
403
  Formatted description string suitable for AI tool documentation
@@ -402,8 +407,9 @@ def generate_tool_description(model: ConnectorModelProtocol) -> str:
402
407
  # at the first empty line and only keeps the initial section.
403
408
 
404
409
  # Entity/action parameter details (including pagination params like limit, starting_after)
405
- search_field_paths = _collect_search_field_paths(model)
406
- lines.append("ENTITIES AND PARAMETERS:")
410
+ search_field_paths = _collect_search_field_paths(model) if enable_hosted_mode_features else {}
411
+ # Avoid a "PARAMETERS:" header because some docstring parsers treat it as a params section marker.
412
+ lines.append("ENTITIES (ACTIONS + PARAMS):")
407
413
  for entity in model.entities:
408
414
  lines.append(f" {entity.name}:")
409
415
  actions = getattr(entity, "actions", []) or []
@@ -427,8 +433,9 @@ def generate_tool_description(model: ConnectorModelProtocol) -> str:
427
433
  lines.append(" To paginate: pass starting_after=<last_id> while has_more is true")
428
434
 
429
435
  lines.append("GUIDELINES:")
430
- lines.append(' - Prefer cached search over direct API calls when using execute(): action="search" whenever possible.')
431
- lines.append(" - Direct API actions (list/get/download) are slower and should be used only if search cannot answer the query.")
436
+ if enable_hosted_mode_features:
437
+ lines.append(' - Prefer cached search over direct API calls when using execute(): action="search" whenever possible.')
438
+ lines.append(" - Direct API actions (list/get/download) are slower and should be used only if search cannot answer the query.")
432
439
  lines.append(" - Keep results small: use params.fields, params.query.filter, small params.limit, and cursor pagination.")
433
440
  lines.append(" - If output is too large, refine the query with tighter filters/fields/limit.")
434
441
 
@@ -126,6 +126,17 @@ class Info(BaseModel):
126
126
  x_airbyte_example_questions: ExampleQuestions | None = Field(None, alias="x-airbyte-example-questions")
127
127
  x_airbyte_cache: CacheConfig | None = Field(None, alias="x-airbyte-cache")
128
128
  x_airbyte_replication_config: ReplicationConfig | None = Field(None, alias="x-airbyte-replication-config")
129
+ x_airbyte_skip_suggested_streams: list[str] = Field(
130
+ default_factory=list,
131
+ alias="x-airbyte-skip-suggested-streams",
132
+ description="List of Airbyte suggested streams to skip when validating cache entity coverage",
133
+ )
134
+ x_airbyte_skip_auth_methods: list[str] = Field(
135
+ default_factory=list,
136
+ alias="x-airbyte-skip-auth-methods",
137
+ description="List of Airbyte auth methods to skip when validating auth compatibility. "
138
+ "Use the SelectiveAuthenticator option key (e.g., 'Private App Credentials', 'oauth2.0')",
139
+ )
129
140
 
130
141
 
131
142
  class ServerVariable(BaseModel):
@@ -86,6 +86,16 @@ class Operation(BaseModel):
86
86
  "Validation will generate a warning instead of an error when cassettes are missing."
87
87
  ),
88
88
  )
89
+ x_airbyte_preferred_for_check: bool | None = Field(
90
+ None,
91
+ alias="x-airbyte-preferred-for-check",
92
+ description=(
93
+ "Mark this list operation as the preferred operation for health checks. "
94
+ "When the CHECK action is executed, this operation will be used instead of "
95
+ "falling back to the first available list operation. Choose a lightweight, "
96
+ "always-available endpoint (e.g., users, accounts)."
97
+ ),
98
+ )
89
99
 
90
100
  # Future extensions (commented out, defined for future use)
91
101
  # from .extensions import PaginationConfig
@@ -3,7 +3,7 @@
3
3
  import logging
4
4
  import platform
5
5
  import sys
6
- from datetime import datetime
6
+ from datetime import UTC, datetime
7
7
 
8
8
  from ..observability import ObservabilitySession
9
9
 
@@ -56,7 +56,7 @@ class SegmentTracker:
56
56
 
57
57
  try:
58
58
  event = ConnectorInitEvent(
59
- timestamp=datetime.utcnow(),
59
+ timestamp=datetime.now(UTC),
60
60
  session_id=self.session.session_id,
61
61
  user_id=self.session.user_id,
62
62
  execution_context=self.session.execution_context,
@@ -99,7 +99,7 @@ class SegmentTracker:
99
99
 
100
100
  try:
101
101
  event = OperationEvent(
102
- timestamp=datetime.utcnow(),
102
+ timestamp=datetime.now(UTC),
103
103
  session_id=self.session.session_id,
104
104
  user_id=self.session.user_id,
105
105
  execution_context=self.session.execution_context,
@@ -129,7 +129,7 @@ class SegmentTracker:
129
129
 
130
130
  try:
131
131
  event = SessionEndEvent(
132
- timestamp=datetime.utcnow(),
132
+ timestamp=datetime.now(UTC),
133
133
  session_id=self.session.session_id,
134
134
  user_id=self.session.user_id,
135
135
  execution_context=self.session.execution_context,
@@ -15,7 +15,16 @@ from .schema.security import AirbyteAuthConfig
15
15
 
16
16
 
17
17
  class Action(str, Enum):
18
- """Supported actions for Entity operations."""
18
+ """Supported actions for Entity operations.
19
+
20
+ Standard CRUD actions:
21
+ GET, CREATE, UPDATE, DELETE, LIST
22
+
23
+ Special actions:
24
+ API_SEARCH - Search via API endpoint
25
+ DOWNLOAD - Download file content
26
+ AUTHORIZE - OAuth authorization flow
27
+ """
19
28
 
20
29
  GET = "get"
21
30
  CREATE = "create"
@@ -223,6 +232,12 @@ class EndpointDefinition(BaseModel):
223
232
  description="Mark operation as untested to skip cassette validation (from x-airbyte-untested extension)",
224
233
  )
225
234
 
235
+ # Health check support (Airbyte extension)
236
+ preferred_for_check: bool = Field(
237
+ False,
238
+ description="Mark this list operation as preferred for health checks (from x-airbyte-preferred-for-check extension)",
239
+ )
240
+
226
241
 
227
242
  class EntityDefinition(BaseModel):
228
243
  """Definition of an API entity."""
@@ -5,6 +5,7 @@ These tools help ensure that connectors are ready to ship by:
5
5
  - Checking that all entity/action operations have corresponding test cassettes
6
6
  - Validating that response schemas match the actual cassette responses
7
7
  - Detecting fields present in responses but not declared in schemas
8
+ - Validating replication compatibility with Airbyte source connectors
8
9
  """
9
10
 
10
11
  from collections import defaultdict
@@ -21,6 +22,7 @@ from .connector_model_loader import (
21
22
  )
22
23
  from .testing.spec_loader import load_test_spec
23
24
  from .types import Action, EndpointDefinition
25
+ from .validation_replication import validate_replication_compatibility
24
26
 
25
27
 
26
28
  def build_cassette_map(cassettes_dir: Path) -> Dict[Tuple[str, str], List[Path]]:
@@ -808,13 +810,52 @@ def validate_connector_readiness(connector_dir: str | Path) -> Dict[str, Any]:
808
810
  }
809
811
  )
810
812
 
811
- success = operations_missing_cassettes == 0 and cassettes_invalid == 0 and total_operations > 0
813
+ # Validate replication compatibility with Airbyte
814
+ replication_result = validate_replication_compatibility(
815
+ connector_yaml_path=config_file,
816
+ raw_spec=raw_spec,
817
+ )
818
+
819
+ # Merge replication errors/warnings into totals
820
+ # Note: If connector is not in registry, we don't count warnings since this is expected for test connectors
821
+ replication_errors = replication_result.get("errors", [])
822
+ replication_warnings = replication_result.get("warnings", [])
823
+ total_errors += len(replication_errors)
824
+
825
+ # Only count replication warnings if the connector was found in the registry
826
+ # (i.e., there are actual validation issues, not just "not found in registry")
827
+ if replication_result.get("registry_found", False):
828
+ total_warnings += len(replication_warnings)
829
+
830
+ # Update success criteria to include replication validation
831
+ success = operations_missing_cassettes == 0 and cassettes_invalid == 0 and total_operations > 0 and len(replication_errors) == 0
832
+
833
+ # Check for preferred_for_check on at least one list operation
834
+ has_preferred_check = False
835
+ for entity in config.entities:
836
+ for action_val in entity.actions:
837
+ endpoint = entity.endpoints.get(action_val)
838
+ if endpoint and getattr(endpoint, "preferred_for_check", False):
839
+ has_preferred_check = True
840
+ break
841
+ if has_preferred_check:
842
+ break
843
+
844
+ readiness_warnings = []
845
+ if not has_preferred_check:
846
+ readiness_warnings.append(
847
+ "No operation has x-airbyte-preferred-for-check: true. "
848
+ "Add this extension to a lightweight list operation (e.g., users.list) "
849
+ "to enable reliable health checks."
850
+ )
812
851
 
813
852
  return {
814
853
  "success": success,
815
854
  "connector_name": config.name,
816
855
  "connector_path": str(connector_path),
817
856
  "validation_results": validation_results,
857
+ "replication_validation": replication_result,
858
+ "readiness_warnings": readiness_warnings,
818
859
  "summary": {
819
860
  "total_operations": total_operations,
820
861
  "operations_with_cassettes": operations_with_cassettes,