Module models 

Transport-agnostic models of the graph-storage contract.

These types cross three boundaries — the ClientHub trait, the REST DTO layer (which owns all serde), and the plugin contracts — so they carry no serde derives, no HTTP types and no database types. Payloads are arbitrary GTS-validated JSON and travel as serde_json::Value.

Structs

AdjacencyEntry

One incident edge in a node read.

ArmHit

A hit’s per-arm provenance: which arm matched, at what rank and raw score.

ComponentReadiness

One row of the readiness matrix, as the endpoint reports it.

DeleteOutcome

Outcome of a soft delete.

EdgeRef

A traversed edge reference.

EdgeSpec

An edge submitted for ingest, addressed by its endpoint node keys.

EdgeView

An edge as the edge read returns it.

EffectiveTraits

Trait values resolved across the whole derivation chain, stored with the registered type so batch validation never repeats the walk.

ElementEnvelope

The gear-assigned half of an element, identical for every node and every edge and described by the API schema rather than by the element’s GTS type – a producer can neither supply nor extend it, and a type registered statically in the types-registry has nothing to put in it.

EmbeddingSpaceId

Full embedding-space identity. Two providers with the same dimension and different identities produce incomparable vectors, so the identity is more than a width.

EngineCapabilities

What an engine implementation provides beyond one-hop expansion.

GraphRevision

The snapshot identity every compound read observes and reports: the deployment-wide, non-reusable source epoch paired with the per-tenant monotonic revision.

HopBudget

Per-hop budget.

IngestCounts

Aggregate counters of one committed batch.

IngestOptions

Per-request ingest options.

IngestOutcome

Outcome of one ingest call.

IngestRequest

One atomic ingest batch.

ItemError

One per-item validation failure. A batch with any of these commits nothing.

LabelAssignment

LabelFilter

Label filter placeholder (labels are not shipped in this iteration; the field exists so the plugin contract does not change when they are).

LabelRecord

LabelSpec

MigrationSpec

What to do with one type’s stored payloads so they satisfy the candidate.

NeighborhoodRequest

Bounded neighborhood projection request.

NodeQuery

Filterable-field schema of the node projection.

NodeRow

One row of the tabular projection.

NodeSpec

A node submitted for ingest. An upsert replaces the row’s mutable state wholesale: a field the request omits is cleared, never preserved.

NodeView

A node as read paths return it.

Page

A page of results with an opaque continuation token bound to the observed revision (Read Consistency Contract).

ProjectionRequest

Tabular projection query.

ReadSnapshot

Handle to one open compound-read snapshot. Opaque to callers; the store that issued it resolves it back to a live snapshot.

Readiness

What GET /health/ready answers.

RegisteredType

A registered type plus what this call did to it.

RemainingBudget

What is left of an operation’s absolute deadline — never a fresh timeout, so a slow earlier step shortens the next one rather than extending the total.

ReplaceScope

Declarative scope replacement carried by an ingest batch.

RevisionOutcome

Revision-only outcome for label mutations.

SchemaDiagnostic

One reason a directional verdict does not hold, with the schema location that carries it — so a refusal points at $.payload rather than saying “incompatible”.

SearchHit

One fused search hit.

SearchRequest

One search request.

SearchResponse

Search response, revision-stamped like every compound read.

SourceNamespaceOwner

One source namespace and the producer principal bound to it.

StoreCapabilities

What a store implementation provides. Anything absent is answered Unsupported, never approximated.

Subject

The party behind a write, in the platform’s own vocabulary rather than in a vocabulary of this gear’s own: SecurityContext’s subject_id and optional subject_type.

TopologyPage

TopologyRequest

TraitChange

How one trait’s declared paths changed between the two definitions.

TraversalResponse

Traversal / neighborhood response.

TraverseRequest

Seeded, depth-bounded traversal request.

TypeChange

The full verdict on one candidate: what the dry run reports and what a refusal explains itself with.

TypeIdSet

A resolved set of registered types, the single representation on which a caller’s type filter and an authorizing permission’s pattern intersect.

TypeQuery

Filter for listing registered types.

TypeRecord

A registered type as the gear reports it.

TypeRegistration

One type submitted for registration.

TypeRegistrationOptions

Per-batch registration options.

UnknownVariant

A wire or storage string that names no variant of a closed enum.

Enums

AdjacencySide

Edge incidence direction relative to a node.

AdmissionBasis

Why an update was admitted. Two grounds, never conflated in a report.

DeleteRequest

Soft-delete target.

Direction

Expansion direction. Either is the union of the two directed scans in one semi-join — never the undirected pattern shorthand, which plans as an all-vertex probe.

ItemFamily

Which collection an ingest item belongs to.

ItemOutcome

Per-item outcome, reported when options.report_per_item is set.

LabelAppliesTo

LabelTarget

MigrationStep

One step of a payload migration.

NodeFilterField

NodeQueryFilterField

OnExisting

What a registration batch may do to an identifier that is already registered with a different schema.

ReadinessState

The state of one capability (DESIGN § Readiness Matrix).

SearchArm

Which arm produced a hit.

SearchMode

Search mode. Hybrid runs both arms independently and fuses them with RRF.

TruncationReason

Why an expansion or traversal stopped early. Never silent.

TypeChangeState

How the candidate stands against the registered definition.

TypeKind

Kind of a registrable GTS type.

TypeOutcome

What one registration did.

Constants

AUTHZ

DATABASE

Matrix row names, spelled once so the endpoint and the documentation cannot drift apart.

DYNAMIC_INDEXES

EMBEDDING_PROVIDER

EMBEDDING_SPACE

GRAPH_ENGINE

METRIC_ANNOTATION

SQLPGQ

TENANT_RECONCILIATION

TYPES_REGISTRY

Functions

canonical_json

One rendering per JSON value, for everything in this contract that identifies something by hashing it.

Type Aliases

EdgeId

Internal edge identity, with the same per-tenant caveat as NodeId.

EdgeKey

Deterministic edge key derived from (type, src, dst, discriminator).

GtsTypeId

Canonical GTS type identifier (gts.vendor.package._.type.v1~ form).

LabelId

Interned label identity.

NodeId

Internal node identity. Surrogate and per-tenant: two tenants may both own a node 17, so it is never meaningful outside a tenant-scoped call.

NodeKey

Producer-supplied stable node key, unique within a tenant.

TenantId

Tenant identity, as carried by the platform security context.