Skip to content

Schema Reference

Canonical JSON Schemas published from anolishq/anolis v0.1.5.

Pin: schemas/anolis-version.jsonanolis_version: 0.1.5

These URLs are stable and resolve to the current pinned schema version:

Schema$id / URLDescription
Runtime Confighttps://anolishq.github.io/schemas/anolis/runtime/runtime-config.schema.jsonCompatibility-preserving schema for runtime YAML consumed by anolis-runtime.
Machine Profilehttps://anolishq.github.io/schemas/anolis/machine/machine-profile.schema.jsonContract for machine package manifests under config/<machine_id>/machine-profile.yaml.
Telemetry Timeserieshttps://anolishq.github.io/schemas/anolis/telemetry/telemetry-timeseries.schema.v1.jsonLogical row contract for anolis_signal telemetry records consumed by the telemetry exporter.

OpenAPI Contract

ContractURLDescription
Runtime HTTP APIhttps://anolishq.github.io/schemas/anolis/http/runtime-http.openapi.v0.yamlOpenAPI 3.x contract for the runtime /v0 HTTP surface.

Usage

VS Code / editor tooling

Add a yaml.schemas entry to .vscode/settings.json:

json
{
  "yaml.schemas": {
    "https://anolishq.github.io/schemas/anolis/runtime/runtime-config.schema.json": "config/anolis-runtime*.yaml",
    "https://anolishq.github.io/schemas/anolis/machine/machine-profile.schema.json": "config/**/machine-profile.yaml"
  }
}

Python / jsonschema

python
import urllib.request, json, jsonschema
url = "https://anolishq.github.io/schemas/anolis/runtime/runtime-config.schema.json"
schema = json.loads(urllib.request.urlopen(url).read())
jsonschema.validate(instance=config, schema=schema)