ApprovalCuaStep

One consequential step. A client renders “Step N: “” — “; a key step names its chord, and only a step with a point (and no label or chord) reads “at x,y”.

Fields and variants

• action
• chord
• effect
• kind
• label
• point
• roleWord
• step

Source

schema/msp/experimental/msp.schema.json#/types/ApprovalCuaStep

{
  "description": "One consequential step. A client renders \"Step N: <action> <roleWord>\n\"<label>\" — <effect>\"; a key step names its `chord`, and only a step with\na `point` (and no label or chord) reads \"at x,y\".",
  "properties": {
    "action": {
      "description": "The host's verb phrase, such as `click` or `type into`.",
      "type": "string"
    },
    "chord": {
      "description": "The chord, for a key step.",
      "type": "string"
    },
    "effect": {
      "description": "The host's trusted sentence for what the step may do.",
      "type": "string"
    },
    "kind": {
      "description": "An open tag for styling and tests only (`verb:<class>`, `unresolved`,\n`unlabeled`); a client that doesn't know a value renders the step from\n`effect` and its label as usual.",
      "type": "string"
    },
    "label": {
      "description": "The control's label: the app's own text, shown quoted and as plain\ntext; a client may cap it.",
      "type": "string"
    },
    "point": {
      "$ref": "#/$defs/ApprovalCuaPoint",
      "description": "The step's own 0–1000 model coordinates, only for a point step."
    },
    "roleWord": {
      "description": "`button`, `link`, `menu item` or `key`; absent for a point step.",
      "type": "string"
    },
    "step": {
      "description": "1-based, as the batch numbers its steps.",
      "type": "integer"
    }
  },
  "required": [
    "action",
    "effect",
    "kind",
    "step"
  ],
  "type": "object"
}