analitiq-contract-models 1.0.0rc1

Analitiq connector/connection/stream/pipeline/endpoint contract models (Pydantic) — the authored write-contract subset the published JSON Schemas and the validator both derive from. Import as `analitiq.contracts`.

analitiq-contract-models

The Analitiq authored contract models (Pydantic) — the write/input shapes for connectors, connections, endpoints, type-maps, streams, and pipelines. These are the single source of truth the published JSON Schemas (schemas.analitiq.ai) are generated from, packaged so the validator and the pipeline engine can validate documents against the contract directly (model_validate) instead of re-implementing its cross-field rules.

Install & use

pip install analitiq-contract-models

from analitiq.contracts.endpoints import ApiEndpointDoc
from pydantic import ValidationError

try:
    ApiEndpointDoc.model_validate(doc)   # structural + cross-field, offline
except ValidationError as exc:
    ...  # every contract rule, enforced from the one source

Importing needs no environment: the package defaults DOMAIN to the public contract host (analitiq.ai) before the models load.

What it ships

The authored write/input contract only — nothing internal:

• analitiq.contracts.connector — ConnectorConfig
• analitiq.contracts.connection — ConnectionInput
• analitiq.contracts.endpoints — ApiEndpointDoc, DatabaseEndpointDoc, DatabaseObject
• analitiq.contracts.type_map — TypeMapReadDoc, TypeMapWriteDoc
• analitiq.contracts.stream — StreamInput (+ the endpoint refs)
• analitiq.contracts.pipelines.config — PipelineInput
• analitiq.contracts.endpoint_identity — derive_db_endpoint_id
• analitiq.contracts.shared — the shared building blocks those embed

Internal persistence/catalog variants (*Document/*Config/*Patch/*Read, resolved-connector/catalog shapes, auth-state) are not included — the package is the public contract surface, no more.

analitiq is a PEP 420 namespace shared with analitiq-validator.

Source of truth

The models are rendered on release from the canonical Analitiq contract models — there is no second, re-authored copy. The published JSON Schemas and this package are two renderings of the same models, so they cannot drift. The build guards that no internal identifier or private path can leak into the public package.

Versioning

analitiq-contract-models is a strict validator (extra=forbid, closed enums), so version bumps are coordinated: a consumer on an older minor rejects a newly-added field a producer emits. See the publishing/versioning notes in the source repo for the major/minor/patch semantics and the consumer rollout rule.