Skip to main content

Crate hyphae_contracts

Crate hyphae_contracts 

Source
Expand description

Canonical public contract documents embedded for validation and generation.

Modules§

v1
Typed version 1 HTTP wire models and deterministic domain conversions.
v2
Native HTTP v2 JSON error and provisional-stream wire models.

Constants§

CAPABILITIES_SCHEMA_V1
JSON Schema for the version 1 capability response.
COMMIT_RECEIPT_SCHEMA_V1
JSON Schema for version 1 durable commit receipts.
DEFINE_LEXICAL_INDEX_REQUEST_SCHEMA_V1
JSON Schema for immutable lexical-index definition requests.
DEFINE_VECTOR_SPACE_REQUEST_SCHEMA_V1
JSON Schema for immutable vector-space definition requests.
DELETE_REQUEST_SCHEMA_V1
JSON Schema for version 1 atomic delete requests.
DELETE_VECTORS_REQUEST_SCHEMA_V1
JSON Schema for atomic durable vector deletion requests.
ERROR_SCHEMA_V1
JSON Schema for the version 1 error envelope.
EXACT_RETRIEVAL_REQUEST_SCHEMA_V1
JSON Schema for durable exact-retrieval requests.
EXACT_RETRIEVAL_RESPONSE_SCHEMA_V1
JSON Schema for proof-bearing exact-retrieval responses.
GET_REQUEST_SCHEMA_V1
JSON Schema for version 1 exact-get requests.
GET_RESPONSE_SCHEMA_V1
JSON Schema for version 1 proof-bearing get responses.
HEALTH_SCHEMA_V1
JSON Schema for version 1 liveness and readiness responses.
HYBRID_RETRIEVAL_REQUEST_SCHEMA_V1
JSON Schema for deterministic hybrid-retrieval requests.
HYBRID_RETRIEVAL_RESPONSE_SCHEMA_V1
JSON Schema for proof-bearing hybrid-retrieval responses.
LEXICAL_RETRIEVAL_REQUEST_SCHEMA_V1
JSON Schema for durable lexical-retrieval requests.
LEXICAL_RETRIEVAL_RESPONSE_SCHEMA_V1
JSON Schema for proof-bearing lexical-retrieval responses.
NATIVE_SCHEMA_V2
JSON Schema for the complete Native v2 operation vocabulary.
OPENAPI_V1
OpenAPI 3.1 document for HTTP API version 1.
OPENAPI_V2
OpenAPI 3.1 document for the Native HTTP version 2 adapter.
PRODUCT_ERROR_SCHEMA_V2
JSON Schema for Native HTTP v2 Product errors.
PROOF_SCHEMA_V1
JSON Schema for version 1 result-proof transport.
PUT_REQUEST_SCHEMA_V1
JSON Schema for version 1 atomic put requests.
PUT_VECTORS_REQUEST_SCHEMA_V1
JSON Schema for atomic durable vector upsert requests.
QUERY_REQUEST_SCHEMA_V1
JSON Schema for version 1 structured query requests.
QUERY_RESPONSE_SCHEMA_V1
JSON Schema for version 1 proof-bearing query responses.
READ_STREAM_SCHEMA_V2
JSON Schema for provisional Native HTTP v2 read stream records.
RETRIEVAL_PROOF_SCHEMA_V1
JSON Schema for canonical retrieval-proof transport.
V1_COMPATIBILITY_SCHEMA_V2
JSON Schema for the explicit Native /v1 compatibility policy.