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

​
Summary

Remove border for a specific side or all sides of a paragraph.
  • Operation ID: format.paragraph.clearBorder
  • API member path: editor.doc.format.paragraph.clearBorder(...)
  • 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 the border is already absent.

​
Input fields

FieldTypeRequiredDescription
sideenumyes"top", "bottom", "left", "right", "between", "bar", "all"
targetParagraphAddress \HeadingAddress \ListItemAddressyesOne of: ParagraphAddress, HeadingAddress, ListItemAddress

​
Example request

{
  "side": "top",
  "target": {
    "kind": "block",
    "nodeId": "node-def456",
    "nodeType": "paragraph"
  }
}

​
Output fields

No fields.

​
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

{
  "additionalProperties": false,
  "properties": {
    "side": {
      "enum": [
        "top",
        "bottom",
        "left",
        "right",
        "between",
        "bar",
        "all"
      ]
    },
    "target": {
      "oneOf": [
        {
          "$ref": "#/$defs/ParagraphAddress"
        },
        {
          "$ref": "#/$defs/HeadingAddress"
        },
        {
          "$ref": "#/$defs/ListItemAddress"
        }
      ]
    }
  },
  "required": [
    "target",
    "side"
  ],
  "type": "object"
}

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

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