Summary
Insert a bibliography block at a target location.- Operation ID:
citations.bibliography.insert - API member path:
editor.doc.citations.bibliography.insert(...) - Mutates document:
yes - Idempotency:
non-idempotent - Supports tracked mode:
no - Supports dry run:
yes - Deterministic target resolution:
yes
Expected result
Returns a BibliographyMutationResult indicating success with the bibliography address or a failure.Input fields
| Field | Type | Required | Description |
|---|---|---|---|
at | object(kind=“documentStart”) | object(kind=“documentEnd”) | object(kind=“before”) | object(kind=“after”) | yes | One of: object(kind=“documentStart”), object(kind=“documentEnd”), object(kind=“before”), object(kind=“after”) |
style | string | no |
Example request
{
"at": {
"kind": "documentStart"
},
"style": "example"
}
Output fields
Variant 1 (success=true)
| Field | Type | Required | Description |
|---|---|---|---|
bibliography | object(kind=“block”) | yes | |
bibliography.kind | "block" | yes | Constant: "block" |
bibliography.nodeId | string | yes | |
bibliography.nodeType | "bibliography" | yes | Constant: "bibliography" |
success | true | yes | Constant: true |
Variant 2 (success=false)
| Field | Type | Required | Description |
|---|---|---|---|
failure | object | yes | |
failure.code | string | yes | |
failure.details | any | no | |
failure.message | string | yes | |
success | false | yes | Constant: false |
Example response
{
"bibliography": {
"kind": "block",
"nodeId": "node-def456",
"nodeType": "bibliography"
},
"success": true
}
Pre-apply throws
TARGET_NOT_FOUNDINVALID_TARGETINVALID_INPUTCAPABILITY_UNAVAILABLE
Non-applied failure codes
- None
Raw schemas
Raw input schema
Raw input schema
{
"additionalProperties": false,
"properties": {
"at": {
"oneOf": [
{
"additionalProperties": false,
"properties": {
"kind": {
"const": "documentStart"
}
},
"required": [
"kind"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"kind": {
"const": "documentEnd"
}
},
"required": [
"kind"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"kind": {
"const": "before"
},
"target": {
"$ref": "#/$defs/BlockNodeAddress"
}
},
"required": [
"kind",
"target"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"kind": {
"const": "after"
},
"target": {
"$ref": "#/$defs/BlockNodeAddress"
}
},
"required": [
"kind",
"target"
],
"type": "object"
}
]
},
"style": {
"type": "string"
}
},
"required": [
"at"
],
"type": "object"
}
Raw output schema
Raw output schema
{
"oneOf": [
{
"additionalProperties": false,
"properties": {
"bibliography": {
"additionalProperties": false,
"properties": {
"kind": {
"const": "block"
},
"nodeId": {
"type": "string"
},
"nodeType": {
"const": "bibliography"
}
},
"required": [
"kind",
"nodeType",
"nodeId"
],
"type": "object"
},
"success": {
"const": true
}
},
"required": [
"success",
"bibliography"
],
"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"
}
]
}
Raw success schema
Raw success schema
{
"additionalProperties": false,
"properties": {
"bibliography": {
"additionalProperties": false,
"properties": {
"kind": {
"const": "block"
},
"nodeId": {
"type": "string"
},
"nodeType": {
"const": "bibliography"
}
},
"required": [
"kind",
"nodeType",
"nodeId"
],
"type": "object"
},
"success": {
"const": true
}
},
"required": [
"success",
"bibliography"
],
"type": "object"
}
Raw failure schema
Raw failure schema
{
"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"
}