LiveEditBody

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/microworker/main/json-schema/microworker-live-edit-body-schema.json",
  "title": "LiveEditBody",
  "description": "Send only what changes. The kinds of proof, the money and who can take the task are not editable here.",
  "x-generated": "2026-10-22",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/_original/microworker-v1-openapi.json#/components/schemas/LiveEditBody",
  "type": "object",
  "properties": {
    "title": {
      "type": "string",
      "minLength": 5,
      "maxLength": 140
    },
    "instructions": {
      "type": "string",
      "minLength": 20,
      "maxLength": 8000,
      "description": "The steps, one per line, as when the task was created."
    },
    "proof_notes": {
      "type": "array",
      "minItems": 1,
      "maxItems": 5,
      "items": {
        "type": [
          "string",
          "null"
        ],
        "maxLength": 500
      },
      "description": "One entry per proof requirement, in the order GET /tasks/{id} lists `proofs`: its new note, or null or \"\" to clear it. A list of another length answers 409 `proof_kinds_locked` with `count`."
    },
    "media_steps": {
      "type": "array",
      "maxItems": 100,
      "description": "Move attachments between steps.",
      "items": {
        "type": "object",
        "required": [
          "id",
          "step_index"
        ],
        "properties": {
          "id": {
            "type": "integer",
            "description": "An attachment of this task (`media[].id`)."
          },
          "step_index": {
            "type": [
              "integer",
              "null"
            ],
            "minimum": 0,
            "description": "The step (0-based) it belongs to; null = the task as a whole."
          }
        }
      }
    },
    "message": {
      "type": "string",
      "maxLength": 500,
      "description": "What to tell the people working on it about the change. Sent to them and posted as a note, with e-mail addresses and phone numbers hidden. Left out or blank: they are told the task was updated."
    },
    "dry_run": {
      "type": "boolean",
      "default": false,
      "description": "Run every check and answer what would happen; change nothing."
    }
  }
}