images.convertToInline

Convert a floating image to inline placement.

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

Summary

Convert a floating image to inline placement.

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

Expected result

Returns an ImagesMutationResult; reports NO_OP if already inline.

Input fields

Field	Type	Required	Description
imageId	string	yes

Example request

{
  "imageId": "example"
}

Output fields

Field	Type	Required	Description
failure	object	no
image	object	no
success	boolean	no

Example response

{
  "image": {},
  "success": true
}

Pre-apply throws

• TARGET_NOT_FOUND
• AMBIGUOUS_TARGET
• INVALID_TARGET
• CAPABILITY_UNAVAILABLE

Non-applied failure codes

• NO_OP

Raw schemas

Raw input schema

{
  "additionalProperties": false,
  "properties": {
    "imageId": {
      "type": "string"
    }
  },
  "required": [
    "imageId"
  ],
  "type": "object"
}

Raw output schema

{
  "additionalProperties": false,
  "properties": {
    "failure": {
      "type": "object"
    },
    "image": {
      "type": "object"
    },
    "success": {
      "type": "boolean"
    }
  },
  "type": "object"
}

Raw success schema

{
  "additionalProperties": false,
  "properties": {
    "image": {
      "type": "object"
    },
    "success": {
      "const": true
    }
  },
  "required": [
    "success",
    "image"
  ],
  "type": "object"
}

Raw failure schema

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