Expand description
HTTP wire DTOs. The types and their engine-result -> DTO mappings live
in the shared omnigraph-api-types crate (RFC-009 Phase 2) so the CLI
and server share one definition; re-exported here so every
omnigraph_server::api::* path (handlers, the OpenApi schema list,
CLI imports) keeps resolving unchanged. Only query_catalog_entry
stays — it maps the server’s runtime StoredQuery (not a wire type)
into the shared QueryCatalogEntry DTO.
Structs§
- Branch
Create Output - Branch
Create Request - Branch
Delete Output - Branch
List Output - Branch
Merge Output - Branch
Merge Request - Change
Output - Change
Request - Commit
List Output - Commit
List Query - Commit
Output - Error
Output - Export
Request - Graph
Info - One entry in the response from
GET /graphs. Cluster operators consume this list to discover which graphs the server is currently serving. The shape is intentionally minimal —graph_idanduriare the only fields a routing client needs. - Graph
List Response - Response from
GET /graphs. Lists every graph registered with the server in alphabetical order bygraph_id(sorted server-side so clients get deterministic output across requests). - Health
Output - Ingest
Output - Ingest
Request - Ingest
Table Output - Invoke
Stored Query Request - Body for
POST /queries/{name}— invokes the server-side stored query named in the path. The query source and name come from the registry, never the body; only the runtime inputs are supplied here. - Manifest
Conflict Output - Structured details for a publisher-level OCC failure. Surfaces alongside HTTP 409 when a write was rejected because the caller’s pre-write view of one table’s manifest version was stale relative to the current head. The expected/actual fields tell the client which table to refresh.
- Merge
Conflict Output - Param
Descriptor - One declared parameter of a stored query, projected for the catalog.
- Queries
Catalog Output - Response for
GET /queries: themcp.exposesubset of a graph’s stored-query registry, each with typed parameters. - Query
Catalog Entry - One entry in the stored-query catalog (
GET /queries). - Query
Request - Inline read-query request for
POST /query. - Read
Output - Read
Request - Read
Target Output - Schema
Apply Output - Schema
Apply Request - Schema
Output - Snapshot
Output - Snapshot
Query - Snapshot
Table Output
Enums§
- Branch
Merge Outcome - Error
Code - Invoke
Stored Query Response - Response for
POST /queries/{name}: the read envelope for a stored read, or the mutation envelope for a stored mutation. Serialized untagged, so the wire shape is exactlyReadOutputorChangeOutput— classification follows the stored query, not a wrapper field. - Merge
Conflict Kind Output - Param
Kind - The kind of a stored-query parameter, decomposed so a client (e.g. an
MCP server) can build a typed input schema with a closed
matchand never re-parse omnigraph’s type spelling.bigint/date/datetime/blobare carried as JSON strings on the wire: a 64-bit integer past 2^53 loses precision as a JSON number, and Date/DateTime are ISO strings, Blob a blob-URI string.
Functions§
- commit_
output - ingest_
output - param_
descriptor - query_
catalog_ entry - Project a loaded stored query into its catalog entry (typed params, MCP tool name, read/mutate flag, description/instruction).
- read_
output - read_
target_ output - schema_
apply_ output - snapshot_
payload