Schemas / Other

rig.dev.op

v0.31.0 · draft 4 fields 3 required

Fields

FieldTypeMeaning
machine entity required Owning rig.dev.machine
order int required Sort key within the machine
opId string required Operation catalog id (e.g. ssh, open-editor, open-terminal, preview, apply)
enabled bool optional Optional. Whether the op can be invoked; absent = true

A named operation on a prepared rig.dev.machine. Edges toward behavior; what the op does is fulfillment - the Contract only names which command the surface exposes.

Labels compose rig.meta.named. Prefer shared opId names that both hosts implement. Unknown ids may be hidden or disabled (ship what you support). Host-private ids are valid but non-portable - see dev.md.

Required: machine, order, opId.

JSON Schema

Resolves at https://rig.works/schemas/rig.dev.op.schema.jsonraw file.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://rig.works/schemas/rig.dev.op.schema.json",
  "title": "rig.dev.op",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "machine": {
      "$ref": "./_defs.schema.json#/$defs/entity"
    },
    "order": {
      "$ref": "./_defs.schema.json#/$defs/int"
    },
    "opId": {
      "$ref": "./_defs.schema.json#/$defs/string"
    },
    "enabled": {
      "$ref": "./_defs.schema.json#/$defs/bool"
    }
  },
  "required": [
    "machine",
    "order",
    "opId"
  ]
}

Seen in

dev-hyperv.json · dev-kvm.json · dev-machine.json