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

​
Summary

Insert a new caption paragraph adjacent to a target block.
  • Operation ID: captions.insert
  • API member path: editor.doc.captions.insert(...)
  • Mutates document: yes
  • Idempotency: non-idempotent
  • Supports tracked mode: no
  • Supports dry run: no
  • Deterministic target resolution: yes

​
Expected result

Returns a CaptionMutationResult indicating success with the caption address or a failure.

​
Input fields

FieldTypeRequiredDescription
adjacentToBlockNodeAddressyesBlockNodeAddress
adjacentTo.kind"block"yesConstant: "block"
adjacentTo.nodeIdstringyes
adjacentTo.nodeTypeenumyes"paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt"
labelstringyes
positionenumyes"above", "below"
textstringno

​
Example request

{
  "adjacentTo": {
    "kind": "block",
    "nodeId": "node-def456",
    "nodeType": "paragraph"
  },
  "label": "Paragraph 1",
  "position": "above",
  "text": "Hello, world."
}

​
Output fields

​
Variant 1 (caption.kind=“block”)

FieldTypeRequiredDescription
captionobject(kind=“block”)yes
caption.kind"block"yesConstant: "block"
caption.nodeIdstringyes
caption.nodeType"paragraph"yesConstant: "paragraph"
successtrueyesConstant: true

​
Variant 2 (success=false)

FieldTypeRequiredDescription
failureobjectyes
failure.codestringyes
failure.detailsanyno
failure.messagestringyes
successfalseyesConstant: false

​
Example response

{
  "caption": {
    "kind": "block",
    "nodeId": "node-def456",
    "nodeType": "paragraph"
  },
  "success": true
}

​
Pre-apply throws

  • TARGET_NOT_FOUND
  • INVALID_TARGET
  • INVALID_INPUT
  • CAPABILITY_UNAVAILABLE

​
Non-applied failure codes

  • None

​
Raw schemas

{
  "additionalProperties": false,
  "properties": {
    "adjacentTo": {
      "$ref": "#/$defs/BlockNodeAddress"
    },
    "label": {
      "type": "string"
    },
    "position": {
      "enum": [
        "above",
        "below"
      ]
    },
    "text": {
      "type": "string"
    }
  },
  "required": [
    "adjacentTo",
    "position",
    "label"
  ],
  "type": "object"
}

{
  "oneOf": [
    {
      "additionalProperties": false,
      "properties": {
        "caption": {
          "additionalProperties": false,
          "properties": {
            "kind": {
              "const": "block"
            },
            "nodeId": {
              "type": "string"
            },
            "nodeType": {
              "const": "paragraph"
            }
          },
          "required": [
            "kind",
            "nodeType",
            "nodeId"
          ],
          "type": "object"
        },
        "success": {
          "const": true
        }
      },
      "required": [
        "success",
        "caption"
      ],
      "type": "object"
    },
    {
      "additionalProperties": false,
      "properties": {
        "failure": {
          "additionalProperties": false,
          "properties": {
            "code": {
              "type": "string"
            },
            "details": {},
            "message": {
              "type": "string"
            }
          },
          "required": [
            "code",
            "message"
          ],
          "type": "object"
        },
        "success": {
          "const": false
        }
      },
      "required": [
        "success",
        "failure"
      ],
      "type": "object"
    }
  ]
}

{
  "additionalProperties": false,
  "properties": {
    "caption": {
      "additionalProperties": false,
      "properties": {
        "kind": {
          "const": "block"
        },
        "nodeId": {
          "type": "string"
        },
        "nodeType": {
          "const": "paragraph"
        }
      },
      "required": [
        "kind",
        "nodeType",
        "nodeId"
      ],
      "type": "object"
    },
    "success": {
      "const": true
    }
  },
  "required": [
    "success",
    "caption"
  ],
  "type": "object"
}

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