airbyte-agent-airtable 0.1.5__py3-none-any.whl

airbyte_agent_airtable/_vendored/connector_sdk/schema/components.py

@@ -0,0 +1,244 @@
+"""
+Component models for OpenAPI 3.1: Schema, Parameter, RequestBody, Response, Components.
+
+References:
+- https://spec.openapis.org/oas/v3.1.0#components-object
+- https://spec.openapis.org/oas/v3.1.0#schema-object
+- https://spec.openapis.org/oas/v3.1.0#parameter-object
+"""
+
+from typing import Any, Dict, List, Literal, Union
+
+from pydantic import BaseModel, ConfigDict, Field
+
+from .security import SecurityScheme
+
+
+class Schema(BaseModel):
+    """
+    JSON Schema definition for data models.
+
+    OpenAPI Reference: https://spec.openapis.org/oas/v3.1.0#schema-object
+
+    Note: Uses Dict[str, Any] for properties to support nested schemas and $ref.
+    Reference resolution happens at runtime in config_loader.py.
+
+    Extensions:
+    - x-airbyte-resource-name: Name of the resource this schema represents (Airbyte extension)
+    """
+
+    model_config = ConfigDict(populate_by_name=True, extra="forbid")
+
+    # Core JSON Schema fields
+    type: str | None = None
+    format: str | None = None
+    title: str | None = None
+    description: str | None = None
+    default: Any | None = None
+    example: Any | None = None
+
+    # Object properties
+    properties: Dict[str, Any] = Field(default_factory=dict)  # May contain $ref
+    required: List[str] = Field(default_factory=list)
+    additional_properties: Any | None = Field(None, alias="additionalProperties")
+
+    # Array properties
+    items: Any | None = None  # May be Schema or $ref
+
+    # Validation
+    enum: List[Any] | None = None
+    min_length: int | None = Field(None, alias="minLength")
+    max_length: int | None = Field(None, alias="maxLength")
+    minimum: float | None = None
+    maximum: float | None = None
+    pattern: str | None = None
+
+    # Composition
+    all_of: List[Any] | None = Field(None, alias="allOf")
+    any_of: List[Any] | None = Field(None, alias="anyOf")
+    one_of: List[Any] | None = Field(None, alias="oneOf")
+    not_: Any | None = Field(None, alias="not")
+
+    # Metadata
+    nullable: bool | None = Field(None, deprecated="Use type union with null instead (OpenAPI 3.1)")
+    read_only: bool | None = Field(None, alias="readOnly")
+    write_only: bool | None = Field(None, alias="writeOnly")
+    deprecated: bool | None = None
+
+    # Airbyte extensions
+    x_airbyte_entity_name: str | None = Field(None, alias="x-airbyte-entity-name")
+    x_airbyte_stream_name: str | None = Field(None, alias="x-airbyte-stream-name")
+
+
+class Parameter(BaseModel):
+    """
+    Operation parameter definition.
+
+    OpenAPI Reference: https://spec.openapis.org/oas/v3.1.0#parameter-object
+    """
+
+    model_config = ConfigDict(populate_by_name=True, extra="forbid")
+
+    name: str
+    in_: Literal["query", "header", "path", "cookie"] = Field(alias="in")
+    description: str | None = None
+    required: bool | None = None
+    deprecated: bool | None = None
+    allow_empty_value: bool | None = Field(None, alias="allowEmptyValue")
+
+    # Schema can be inline or reference
+    schema_: Dict[str, Any] | None = Field(None, alias="schema")
+
+    # Style and examples
+    style: str | None = None
+    explode: bool | None = None
+    example: Any | None = None
+    examples: Dict[str, Any] | None = None
+
+
+class MediaType(BaseModel):
+    """
+    Media type object for request/response content.
+
+    OpenAPI Reference: https://spec.openapis.org/oas/v3.1.0#media-type-object
+    """
+
+    model_config = ConfigDict(populate_by_name=True, extra="forbid")
+
+    schema_: Dict[str, Any] | None = Field(None, alias="schema")
+    example: Any | None = None
+    examples: Dict[str, Any] | None = None
+    encoding: Dict[str, Any] | None = None
+
+
+class GraphQLBodyConfig(BaseModel):
+    """
+    GraphQL body type configuration for x-airbyte-body-type extension.
+
+    Used when x-airbyte-body-type.type = "graphql"
+    """
+
+    model_config = ConfigDict(populate_by_name=True, extra="forbid")
+
+    type: Literal["graphql"] = Field(..., description="Body type identifier (must be 'graphql')")
+    query: str = Field(
+        ...,
+        description="GraphQL query or mutation string with optional template placeholders (e.g., {{ variable }})",
+    )
+    variables: Dict[str, Any] | None = Field(
+        None,
+        description="Variables to substitute in the GraphQL query using template syntax (e.g., {{ param_name }})",
+    )
+    operationName: str | None = Field(None, description="Operation name for queries with multiple operations")
+    default_fields: Union[str, List[str]] | None = Field(
+        None,
+        description="Default fields to select if not provided in request parameters. Can be a string or array of field names.",
+    )
+    nullable_variables: List[str] | None = Field(
+        default=None,
+        alias="x-airbyte-nullable-variables",
+        description="Variable names that can be explicitly set to null (e.g., to unassign a user)",
+    )
+
+
+# Union type for all body type configs (extensible for future types like XML, SOAP, etc.)
+BodyTypeConfig = Union[GraphQLBodyConfig]
+
+
+class PathOverrideConfig(BaseModel):
+    """
+    Path override configuration for x-airbyte-path-override extension.
+
+    Used when the OpenAPI path differs from the actual HTTP endpoint path.
+    Common for GraphQL APIs where multiple resources share the same endpoint (e.g., /graphql).
+
+    Example:
+        OpenAPI path: /graphql:repositories (for uniqueness)
+        Actual HTTP path: /graphql (configured here)
+    """
+
+    model_config = ConfigDict(populate_by_name=True, extra="forbid")
+
+    path: str = Field(
+        ...,
+        description=("Actual HTTP path to use for requests (e.g., '/graphql'). Must start with '/'"),
+    )
+
+
+class RequestBody(BaseModel):
+    """
+    Request body definition.
+
+    OpenAPI Reference: https://spec.openapis.org/oas/v3.1.0#request-body-object
+
+    Airbyte Extensions:
+    See connector_sdk.extensions for documentation:
+    - AIRBYTE_BODY_TYPE: Body type and configuration (nested structure)
+    """
+
+    model_config = ConfigDict(populate_by_name=True, extra="forbid")
+
+    description: str | None = None
+    content: Dict[str, MediaType] = Field(default_factory=dict)
+    required: bool | None = None
+
+    # Airbyte extensions for GraphQL support
+    # See connector_sdk.extensions for AIRBYTE_BODY_TYPE constant
+    x_airbyte_body_type: BodyTypeConfig | None = Field(
+        None,
+        alias="x-airbyte-body-type",  # AIRBYTE_BODY_TYPE
+        description=(
+            "Body type and configuration. Contains 'type' field (e.g., 'graphql') and type-specific configuration (query, variables, etc.)."
+        ),
+    )
+
+
+class Header(BaseModel):
+    """
+    Header definition.
+
+    OpenAPI Reference: https://spec.openapis.org/oas/v3.1.0#header-object
+    """
+
+    model_config = ConfigDict(populate_by_name=True, extra="forbid")
+
+    description: str | None = None
+    required: bool | None = None
+    deprecated: bool | None = None
+    schema_: Dict[str, Any] | None = Field(None, alias="schema")
+    example: Any | None = None
+
+
+class Response(BaseModel):
+    """
+    Response definition.
+
+    OpenAPI Reference: https://spec.openapis.org/oas/v3.1.0#response-object
+    """
+
+    model_config = ConfigDict(populate_by_name=True, extra="forbid")
+
+    description: str
+    headers: Dict[str, Header] | None = None
+    content: Dict[str, MediaType] | None = None
+    links: Dict[str, Any] | None = None
+
+
+class Components(BaseModel):
+    """
+    Reusable component definitions.
+
+    OpenAPI Reference: https://spec.openapis.org/oas/v3.1.0#components-object
+    """
+
+    model_config = ConfigDict(populate_by_name=True, extra="forbid")
+
+    schemas: Dict[str, Schema] = Field(default_factory=dict)
+    responses: Dict[str, Response] = Field(default_factory=dict)
+    parameters: Dict[str, Parameter] = Field(default_factory=dict)
+    examples: Dict[str, Any] | None = None
+    request_bodies: Dict[str, RequestBody] = Field(default_factory=dict, alias="requestBodies")
+    headers: Dict[str, Header] | None = None
+    security_schemes: Dict[str, SecurityScheme] = Field(default_factory=dict, alias="securitySchemes")
+    links: Dict[str, Any] | None = None
+    callbacks: Dict[str, Any] | None = None

airbyte_agent_airtable/_vendored/connector_sdk/schema/connector.py

@@ -0,0 +1,120 @@
+"""
+Root OpenAPI 3.1 connector specification model.
+
+References:
+- https://spec.openapis.org/oas/v3.1.0#openapi-object
+"""
+
+from __future__ import annotations
+
+from collections.abc import Iterator
+from typing import Any
+
+from pydantic import BaseModel, ConfigDict, Field, field_validator
+
+from ..constants import OPENAPI_VERSION_PREFIX
+
+from .base import Info, Server
+from .components import Components
+from .operations import Operation, PathItem
+from .security import SecurityRequirement
+
+
+class Tag(BaseModel):
+    """
+    Tag metadata for grouping operations.
+
+    OpenAPI Reference: https://spec.openapis.org/oas/v3.1.0#tag-object
+    """
+
+    model_config = ConfigDict(populate_by_name=True, extra="forbid")
+
+    name: str
+    description: str | None = None
+    external_docs: dict[str, Any] | None = Field(None, alias="externalDocs")
+
+
+# HTTP methods supported by OpenAPI operations
+HTTP_METHODS = frozenset({"get", "post", "put", "patch", "delete", "options", "head", "trace"})
+
+
+class ExternalDocs(BaseModel):
+    """
+    External documentation reference.
+
+    OpenAPI Reference: https://spec.openapis.org/oas/v3.1.0#external-documentation-object
+    """
+
+    model_config = ConfigDict(populate_by_name=True, extra="forbid")
+
+    description: str | None = None
+    url: str
+
+
+class OpenAPIConnector(BaseModel):
+    """
+    Root OpenAPI 3.1 connector specification.
+
+    OpenAPI Reference: https://spec.openapis.org/oas/v3.1.0#openapi-object
+
+    This is the top-level model that represents a complete OpenAPI 3.1 specification
+    for an Airbyte connector. It enforces strict validation (extra='forbid') to catch
+    typos and unknown extensions.
+    """
+
+    model_config = ConfigDict(populate_by_name=True, extra="forbid", validate_default=True)
+
+    # Required fields
+    openapi: str
+    info: Info
+    paths: dict[str, PathItem] = Field(default_factory=dict)
+
+    # Optional fields
+    servers: list[Server] = Field(default_factory=list)
+    components: Components | None = None
+    security: list[SecurityRequirement] | None = None
+    tags: list[Tag] | None = None
+    external_docs: ExternalDocs | None = Field(None, alias="externalDocs")
+
+    @field_validator("openapi")
+    @classmethod
+    def validate_openapi_version(cls, v: str) -> str:
+        """Validate that OpenAPI version is 3.1.x."""
+        if not v.startswith(OPENAPI_VERSION_PREFIX):
+            raise ValueError(f"OpenAPI version must be {OPENAPI_VERSION_PREFIX}x, got: {v}")
+        return v
+
+    def get_entity_operations(self, entity_name: str) -> list[tuple[str, str, Operation]]:
+        """
+        Get all operations for a specific entity.
+
+        Args:
+            entity_name: The x-airbyte-entity value to filter by
+
+        Returns:
+            List of tuples: (path, method, operation)
+        """
+        return [(path, method, op) for path, method, op in self._iter_operations() if op.x_airbyte_entity == entity_name]
+
+    def list_entities(self) -> list[str]:
+        """
+        List all unique entity names defined in x-airbyte-entity extensions.
+
+        Returns:
+            Sorted list of unique entity names
+        """
+        entities = {op.x_airbyte_entity for _, _, op in self._iter_operations() if op.x_airbyte_entity}
+        return sorted(entities)
+
+    def _iter_operations(self) -> Iterator[tuple[str, str, Operation]]:
+        """
+        Iterate over all operations in the spec.
+
+        Yields:
+            Tuples of (path, method, operation) for each defined operation
+        """
+        for path, path_item in self.paths.items():
+            for method in HTTP_METHODS:
+                operation = getattr(path_item, method, None)
+                if operation:
+                    yield path, method, operation

airbyte_agent_airtable/_vendored/connector_sdk/schema/extensions.py

@@ -0,0 +1,301 @@
+"""
+Extension models for future features.
+
+These models are defined but NOT yet added to the main schema models.
+They serve as:
+1. Type hints for future use
+2. Documentation of planned extensions
+3. Ready-to-use structures when features are implemented
+
+NOTE: These are not currently active in the schema. They will be added
+to Operation, Schema, or other models when their respective features
+are implemented.
+"""
+
+from typing import Literal
+
+from pydantic import BaseModel, ConfigDict, Field
+
+
+class PaginationConfig(BaseModel):
+    """
+    Configuration for pagination support.
+
+    NOT YET USED - Defined for future implementation.
+
+    When active, will be added to Operation model as:
+        x_pagination: Optional[PaginationConfig] = Field(None, alias="x-pagination")
+    """
+
+    model_config = ConfigDict(populate_by_name=True, extra="forbid")
+
+    style: Literal["cursor", "offset", "page", "link"]
+    limit_param: str = "limit"
+
+    # Cursor-based pagination
+    cursor_param: str | None = None
+    cursor_source: Literal["body", "headers"] | None = "body"
+    cursor_path: str | None = None
+
+    # Offset-based pagination
+    offset_param: str | None = None
+
+    # Page-based pagination
+    page_param: str | None = None
+
+    # Response parsing
+    data_path: str = "data"
+    has_more_path: str | None = None
+
+    # Limits
+    max_page_size: int | None = None
+    default_page_size: int = 100
+
+
+class RateLimitConfig(BaseModel):
+    """
+    Configuration for rate limiting.
+
+    NOT YET USED - Defined for future implementation.
+
+    When active, might be added to Server or root OpenAPIConnector as:
+        x_rate_limit: Optional[RateLimitConfig] = Field(None, alias="x-rate-limit")
+    """
+
+    model_config = ConfigDict(populate_by_name=True, extra="forbid")
+
+    max_requests: int
+    time_window_seconds: int
+    retry_after_header: str | None = "Retry-After"
+    respect_retry_after: bool = True
+
+
+class RetryConfig(BaseModel):
+    """
+    Configuration for retry strategy with exponential backoff.
+
+    Used to configure automatic retries for transient errors (429, 5xx, timeouts, network errors).
+    Can be specified at the connector level via x-airbyte-retry-config in the OpenAPI spec's info section.
+
+    By default, retries are enabled with max_attempts=3. To disable retries, set max_attempts=1
+    in your connector's x-airbyte-retry-config.
+
+    Example YAML usage:
+        info:
+          title: My API
+          x-airbyte-retry-config:
+            max_attempts: 5
+            initial_delay_seconds: 2.0
+            retry_after_header: "X-RateLimit-Reset"
+            retry_after_format: "unix_timestamp"
+    """
+
+    model_config = ConfigDict(populate_by_name=True, extra="forbid")
+
+    # Core retry settings (max_attempts=3 enables retries by default)
+    max_attempts: int = 3
+    initial_delay_seconds: float = 1.0
+    max_delay_seconds: float = 60.0
+    exponential_base: float = 2.0
+    jitter: bool = True
+
+    # Which errors to retry
+    retry_on_status_codes: list[int] = [429, 500, 502, 503, 504]
+    retry_on_timeout: bool = True
+    retry_on_network_error: bool = True
+
+    # Header-based delay extraction
+    retry_after_header: str = "Retry-After"
+    retry_after_format: Literal["seconds", "milliseconds", "unix_timestamp"] = "seconds"
+
+
+class CacheFieldProperty(BaseModel):
+    """
+    Nested property definition for object-type cache fields.
+
+    Supports recursive nesting to represent complex nested schemas in cache field definitions.
+    Used when a cache field has type 'object' and needs to define its internal structure.
+
+    Example YAML usage:
+        - name: collaboration
+          type: ['null', 'object']
+          description: "Collaboration data"
+          properties:
+            brief:
+              type: ['null', 'string']
+            comments:
+              type: ['null', 'array']
+    """
+
+    model_config = ConfigDict(populate_by_name=True, extra="forbid")
+
+    type: str | list[str]
+    properties: dict[str, "CacheFieldProperty"] | None = None
+
+
+class CacheFieldConfig(BaseModel):
+    """
+    Field configuration for cache mapping.
+
+    Defines a single field in a cache entity, with optional name aliasing
+    to map between user-facing field names and cache storage names.
+
+    For object-type fields, supports nested properties to define the internal structure
+    of complex nested schemas.
+
+    Used in x-airbyte-cache extension for api_search operations.
+    """
+
+    model_config = ConfigDict(populate_by_name=True, extra="forbid")
+
+    name: str
+    x_airbyte_name: str | None = Field(default=None, alias="x-airbyte-name")
+    type: str | list[str]
+    description: str
+    properties: dict[str, CacheFieldProperty] | None = None
+
+    @property
+    def cache_name(self) -> str:
+        """Return cache name, falling back to name if alias not specified."""
+        return self.x_airbyte_name or self.name
+
+
+class CacheEntityConfig(BaseModel):
+    """
+    Entity configuration for cache mapping.
+
+    Defines a cache-enabled entity with its fields and optional name aliasing
+    to map between user-facing entity names and cache storage names.
+
+    Used in x-airbyte-cache extension for api_search operations.
+    """
+
+    model_config = ConfigDict(populate_by_name=True, extra="forbid")
+
+    entity: str
+    x_airbyte_name: str | None = Field(default=None, alias="x-airbyte-name")
+    fields: list[CacheFieldConfig]
+
+    @property
+    def cache_name(self) -> str:
+        """Return cache entity name, falling back to entity if alias not specified."""
+        return self.x_airbyte_name or self.entity
+
+
+class ReplicationConfigProperty(BaseModel):
+    """
+    Property definition for replication configuration fields.
+
+    Defines a single field in the replication configuration with its type,
+    description, and optional default value.
+
+    Example YAML usage:
+        x-airbyte-replication-config:
+          properties:
+            start_date:
+              type: string
+              title: Start Date
+              description: UTC date and time from which to replicate data
+              format: date-time
+    """
+
+    model_config = ConfigDict(populate_by_name=True, extra="forbid")
+
+    type: str
+    title: str | None = None
+    description: str | None = None
+    format: str | None = None
+    default: str | int | float | bool | None = None
+    enum: list[str] | None = None
+
+
+class ReplicationConfig(BaseModel):
+    """
+    Replication configuration extension (x-airbyte-replication-config).
+
+    Defines replication-specific settings for MULTI mode connectors that need
+    to configure the underlying replication connector. This allows users who
+    use the direct-style API (credentials + environment) to also specify
+    replication settings like start_date, lookback_window, etc.
+
+    This extension is added to the Info model and provides field definitions
+    for replication configuration that gets merged into the source config
+    when creating sources.
+
+    Example YAML usage:
+        info:
+          title: HubSpot API
+          x-airbyte-replication-config:
+            title: Replication Configuration
+            description: Settings for data replication
+            properties:
+              start_date:
+                type: string
+                title: Start Date
+                description: UTC date and time from which to replicate data
+                format: date-time
+            required:
+              - start_date
+            replication_config_key_mapping:
+              start_date: start_date
+    """
+
+    model_config = ConfigDict(populate_by_name=True, extra="forbid")
+
+    title: str | None = None
+    description: str | None = None
+    properties: dict[str, ReplicationConfigProperty] = Field(default_factory=dict)
+    required: list[str] = Field(default_factory=list)
+    replication_config_key_mapping: dict[str, str] = Field(
+        default_factory=dict,
+        alias="replication_config_key_mapping",
+        description="Mapping from replication_config field names to source_config field names",
+    )
+
+
+class CacheConfig(BaseModel):
+    """
+    Cache configuration extension (x-airbyte-cache).
+
+    Defines cache-enabled entities and their field mappings for api_search operations.
+    Supports optional name aliasing via x-airbyte-name for both entities and fields,
+    enabling bidirectional mapping between user-facing names and cache storage names.
+
+    This extension is added to the Info model and provides field-level mapping for
+    search operations that use cached data.
+
+    Example YAML usage:
+        info:
+          title: Stripe API
+          x-airbyte-cache:
+            entities:
+              - entity: customers
+                stream: customers
+                fields:
+                  - name: email
+                    type: ["null", "string"]
+                    description: "Customer email address"
+                  - name: customer_name
+                    x-airbyte-name: name
+                    type: ["null", "string"]
+                    description: "Customer full name"
+    """
+
+    model_config = ConfigDict(populate_by_name=True, extra="forbid")
+
+    entities: list[CacheEntityConfig]
+
+    def get_entity_mapping(self, user_entity: str) -> CacheEntityConfig | None:
+        """
+        Get entity config by user-facing name.
+
+        Args:
+            user_entity: User-facing entity name to look up
+
+        Returns:
+            CacheEntityConfig if found, None otherwise
+        """
+        for entity in self.entities:
+            if entity.entity == user_entity:
+                return entity
+        return None