format.paragraph.setSpacing

Set paragraph spacing properties (before, after, line, lineRule) in twips.

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

Summary

Set paragraph spacing properties (before, after, line, lineRule) in twips.

• Operation ID: format.paragraph.setSpacing
• API member path: editor.doc.format.paragraph.setSpacing(...)
• Mutates document: yes
• Idempotency: conditional
• Supports tracked mode: no
• Supports dry run: yes
• Deterministic target resolution: yes

Expected result

Returns a ParagraphMutationResult; reports NO_OP if spacing already matches.

Input fields

Variant 1

No fields.

Variant 2

No fields.

Variant 3

No fields.

Variant 4

No fields.

Example request

{
  "after": 1,
  "before": 1,
  "line": 1,
  "target": {
    "kind": "block",
    "nodeId": "node-def456",
    "nodeType": "paragraph"
  }
}

Output fields

Variant 1 (success=true)

Field	Type	Required	Description
resolution	object	yes
resolution.target	ParagraphAddress \	HeadingAddress \	ListItemAddress	yes	One of: ParagraphAddress, HeadingAddress, ListItemAddress
success	true	yes	Constant: true
target	ParagraphAddress \	HeadingAddress \	ListItemAddress	yes	One of: ParagraphAddress, HeadingAddress, ListItemAddress

Variant 2 (success=false)

Field	Type	Required	Description
failure	object	yes
failure.code	enum	yes	"NO_OP"
failure.details	any	no
failure.message	string	yes
resolution	object	no
resolution.target	ParagraphAddress \	HeadingAddress \	ListItemAddress	no	One of: ParagraphAddress, HeadingAddress, ListItemAddress
success	false	yes	Constant: false

Example response

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

Pre-apply throws

• TARGET_NOT_FOUND
• INVALID_TARGET
• CAPABILITY_UNAVAILABLE

Non-applied failure codes

• NO_OP

Raw schemas

Raw input schema

{
  "additionalProperties": false,
  "anyOf": [
    {
      "required": [
        "before"
      ]
    },
    {
      "required": [
        "after"
      ]
    },
    {
      "required": [
        "line"
      ]
    },
    {
      "required": [
        "lineRule"
      ]
    }
  ],
  "if": {
    "required": [
      "line"
    ]
  },
  "properties": {
    "after": {
      "minimum": 0,
      "type": "integer"
    },
    "before": {
      "minimum": 0,
      "type": "integer"
    },
    "line": {
      "minimum": 1,
      "type": "integer"
    },
    "lineRule": {
      "enum": [
        "auto",
        "exact",
        "atLeast"
      ]
    },
    "target": {
      "oneOf": [
        {
          "$ref": "#/$defs/ParagraphAddress"
        },
        {
          "$ref": "#/$defs/HeadingAddress"
        },
        {
          "$ref": "#/$defs/ListItemAddress"
        }
      ]
    }
  },
  "required": [
    "target"
  ],
  "then": {
    "required": [
      "lineRule"
    ]
  },
  "type": "object"
}

Raw output schema

{
  "oneOf": [
    {
      "additionalProperties": false,
      "properties": {
        "resolution": {
          "additionalProperties": false,
          "properties": {
            "target": {
              "oneOf": [
                {
                  "$ref": "#/$defs/ParagraphAddress"
                },
                {
                  "$ref": "#/$defs/HeadingAddress"
                },
                {
                  "$ref": "#/$defs/ListItemAddress"
                }
              ]
            }
          },
          "required": [
            "target"
          ],
          "type": "object"
        },
        "success": {
          "const": true
        },
        "target": {
          "oneOf": [
            {
              "$ref": "#/$defs/ParagraphAddress"
            },
            {
              "$ref": "#/$defs/HeadingAddress"
            },
            {
              "$ref": "#/$defs/ListItemAddress"
            }
          ]
        }
      },
      "required": [
        "success",
        "target",
        "resolution"
      ],
      "type": "object"
    },
    {
      "additionalProperties": false,
      "properties": {
        "failure": {
          "additionalProperties": false,
          "properties": {
            "code": {
              "enum": [
                "NO_OP"
              ]
            },
            "details": {},
            "message": {
              "type": "string"
            }
          },
          "required": [
            "code",
            "message"
          ],
          "type": "object"
        },
        "resolution": {
          "additionalProperties": false,
          "properties": {
            "target": {
              "oneOf": [
                {
                  "$ref": "#/$defs/ParagraphAddress"
                },
                {
                  "$ref": "#/$defs/HeadingAddress"
                },
                {
                  "$ref": "#/$defs/ListItemAddress"
                }
              ]
            }
          },
          "required": [
            "target"
          ],
          "type": "object"
        },
        "success": {
          "const": false
        }
      },
      "required": [
        "success",
        "failure"
      ],
      "type": "object"
    }
  ]
}

Raw success schema

{
  "additionalProperties": false,
  "properties": {
    "resolution": {
      "additionalProperties": false,
      "properties": {
        "target": {
          "oneOf": [
            {
              "$ref": "#/$defs/ParagraphAddress"
            },
            {
              "$ref": "#/$defs/HeadingAddress"
            },
            {
              "$ref": "#/$defs/ListItemAddress"
            }
          ]
        }
      },
      "required": [
        "target"
      ],
      "type": "object"
    },
    "success": {
      "const": true
    },
    "target": {
      "oneOf": [
        {
          "$ref": "#/$defs/ParagraphAddress"
        },
        {
          "$ref": "#/$defs/HeadingAddress"
        },
        {
          "$ref": "#/$defs/ListItemAddress"
        }
      ]
    }
  },
  "required": [
    "success",
    "target",
    "resolution"
  ],
  "type": "object"
}

Raw failure schema

{
  "additionalProperties": false,
  "properties": {
    "failure": {
      "additionalProperties": false,
      "properties": {
        "code": {
          "enum": [
            "NO_OP"
          ]
        },
        "details": {},
        "message": {
          "type": "string"
        }
      },
      "required": [
        "code",
        "message"
      ],
      "type": "object"
    },
    "resolution": {
      "additionalProperties": false,
      "properties": {
        "target": {
          "oneOf": [
            {
              "$ref": "#/$defs/ParagraphAddress"
            },
            {
              "$ref": "#/$defs/HeadingAddress"
            },
            {
              "$ref": "#/$defs/ListItemAddress"
            }
          ]
        }
      },
      "required": [
        "target"
      ],
      "type": "object"
    },
    "success": {
      "const": false
    }
  },
  "required": [
    "success",
    "failure"
  ],
  "type": "object"
}