Skip to main content

Module ops

Module ops 

Source
Expand description

Haystack HTTP API op handlers and route registration.

Each sub-module implements one or more Haystack ops as async Actix-Web handler functions. The configure function registers all routes under the /api scope.

Standard ops: about, ops, formats, read, nav, defs, libs, watchSub/watchPoll/watchUnsub, hisRead/hisWrite, pointWrite, invokeAction, close.

Extended ops: changes, export/import, specs/spec/loadLib/ unloadLib/exportLib/validate, system/status/backup/restore, federation/status/sync, rdf/turtle/rdf/jsonld.

Modules§

about
The about op — server identity and SCRAM authentication handshake.
changes
The changes op — return graph changelog entries since a given version.
data
The export and import ops — bulk data import/export.
defs
The defs and libs ops — query the definition namespace.
federation
Federation HTTP endpoints — status and sync for remote connectors.
formats
The formats op — list supported MIME types.
graph
Graph visualization endpoints for React Flow UI integration.
his
The hisRead and hisWrite ops — historical time-series data.
invoke
The invokeAction op — invoke an action on an entity.
libs
Library and spec management endpoints.
nav
The nav op — navigate a project for entity discovery.
ops_handler
The ops op — list all available operations.
point_write
The pointWrite op — write a value to a writable point.
rdf
RDF export endpoints — Turtle and JSON-LD serialization of all entities.
read
The read op — read entities by filter or by id.
system
System administration endpoints (admin-only).
watch
Watch ops — subscribe, poll, and unsubscribe for entity changes.

Functions§

configure
Configure all Haystack API routes under /api.