history.undo

Undo the most recent history-safe mutation in the document.

Summary

Undo the most recent history-safe mutation in the document.

• Operation ID: history.undo
• API member path: editor.doc.history.undo(...)
• Mutates document: yes
• Idempotency: non-idempotent
• Supports tracked mode: no
• Supports dry run: no
• Deterministic target resolution: yes

Expected result

Returns a HistoryActionResult with noop flag, reason (EMPTY_UNDO_STACK | NO_EFFECT when noop), and revision before/after.

Input fields

No fields.

Example request

{}

Output fields

Field	Type	Required	Description
noop	boolean	yes
revision	object	yes
revision.after	string	yes
revision.before	string	yes

Example response

{
  "noop": true,
  "revision": {
    "after": "example",
    "before": "example"
  }
}

Pre-apply throws

• CAPABILITY_UNAVAILABLE

Non-applied failure codes

• None

Raw schemas

Raw input schema

{
  "additionalProperties": false,
  "properties": {},
  "type": "object"
}

Raw output schema

{
  "additionalProperties": false,
  "properties": {
    "noop": {
      "type": "boolean"
    },
    "revision": {
      "additionalProperties": false,
      "properties": {
        "after": {
          "type": "string"
        },
        "before": {
          "type": "string"
        }
      },
      "required": [
        "before",
        "after"
      ],
      "type": "object"
    }
  },
  "required": [
    "noop",
    "revision"
  ],
  "type": "object"
}

Raw success schema

{
  "additionalProperties": false,
  "properties": {
    "noop": {
      "type": "boolean"
    },
    "revision": {
      "additionalProperties": false,
      "properties": {
        "after": {
          "type": "string"
        },
        "before": {
          "type": "string"
        }
      },
      "required": [
        "before",
        "after"
      ],
      "type": "object"
    }
  },
  "required": [
    "noop",
    "revision"
  ],
  "type": "object"
}

Raw failure schema

{
  "additionalProperties": false,
  "properties": {
    "failure": {
      "additionalProperties": false,
      "properties": {
        "code": {
          "enum": [
            "CAPABILITY_UNAVAILABLE"
          ]
        },
        "details": {},
        "message": {
          "type": "string"
        }
      },
      "required": [
        "code",
        "message"
      ],
      "type": "object"
    },
    "success": {
      "const": false
    }
  },
  "required": [
    "success",
    "failure"
  ],
  "type": "object"
}