Skip to content
Settings

Reference

Reference content on this site is a narrative skin over the cyoda-go binary. The binary is self-documenting — every flag, environment variable, endpoint, error code, metric, header, and operation ships with its own help topic. This section points you at the right topics, shows you the REST/gRPC surfaces, and documents the CloudEvent JSON Schemas.

The material here was captured against cyoda-go v0.6.2. For whatever version you are running, cyoda help on your own binary is the authoritative source.

  • cyoda help — navigator over the full topic tree. Every top-level topic and its drilldowns, with synopses. The best first stop.
  • API — REST OpenAPI 3.1 reference, interactive viewer.
  • gRPC — gRPC CloudEventsService (cross-linked from the API page).
  • JSON Schemas — CloudEvent payload schemas, extracted from the pinned binary at build time.
  • Trino SQL — SQL analytics surface (Cyoda Cloud; upcoming).
  • CLI — command-line entry points and global flags.
  • Configuration — configuration model, precedence, profiles, _FILE secrets.
  • Helm values — chart layout, values model, secret provisioning.
  • Entity model export — SIMPLE_VIEW export shape.

Each navigator page carries a “Canonical reference” callout pointing at the corresponding cyoda help <topic> for the authoritative contract.