Skip to main content
Alpha: Document API is currently alpha and subject to breaking changes.

​
Summary

Undo the most recent history-safe mutation in the active editor.
  • 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 and revision before/after; noop is true when the undo stack is empty.

​
Input fields

No fields.

​
Example request

{}

​
Output fields

FieldTypeRequiredDescription
noopbooleanyes
revisionobjectyes

​
Example response

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

​
Pre-apply throws

  • CAPABILITY_UNAVAILABLE

​
Non-applied failure codes

  • None

​
Raw schemas

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

{
  "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"
}

{
  "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"
}

{
  "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"
}