request.json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://github.com/MSApps-Mobile/gh-bridge/schema/request.json",
  "title": "gh-bridge request",
  "description": "Payload pushed by the VM shim to branch req/<uuid>:request.json. The Actions workflow consumes this, runs the corresponding gh command, and produces a response.json on resp/<uuid>.",
  "type": "object",
  "required": ["uuid", "command", "args"],
  "additionalProperties": false,
  "properties": {
    "uuid": {
      "type": "string",
      "description": "Unique ID for this round-trip, used to correlate the request and response branches. Lowercase hex, 32 chars (no dashes).",
      "pattern": "^[0-9a-f]{32}$"
    },
    "command": {
      "type": "string",
      "description": "The gh subcommand, e.g. 'auth status', 'api rate_limit', 'pr create'. Space-separated; the workflow splits on whitespace before invoking gh.",
      "pattern": "^[a-z][a-z0-9 -]{0,64}$"
    },
    "args": {
      "type": "array",
      "description": "Ordered list of arguments passed verbatim to gh after the command.",
      "items": { "type": "string" },
      "maxItems": 64
    },
    "requested_at": {
      "type": "string",
      "format": "date-time",
      "description": "ISO-8601 timestamp when the VM shim created the request. Informational only."
    },
    "client": {
      "type": "string",
      "description": "Free-form tag identifying the caller. Example: 'cowork-session@2026-04-20'.",
      "maxLength": 128
    }
  }
}