You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -41,13 +42,18 @@ Returns a TextMutationReceipt with applied status; receipt reports NO_OP if the
41
42
| Field | Type | Required | Description |
42
43
| --- | --- | --- | --- |
43
44
|`behavior`| DeleteBehavior | no | DeleteBehavior |
45
+
|`in`| StoryLocator | no | StoryLocator |
44
46
|`ref`| string | yes ||
45
47
46
48
### Example request
47
49
48
50
```json
49
51
{
50
52
"behavior": "selection",
53
+
"in": {
54
+
"kind": "story",
55
+
"storyType": "body"
56
+
},
51
57
"target": {
52
58
"end": {
53
59
"blockId": "block-abc123",
@@ -191,6 +197,11 @@ Returns a TextMutationReceipt with applied status; receipt reports NO_OP if the
191
197
-`CAPABILITY_UNAVAILABLE`
192
198
-`INVALID_TARGET`
193
199
-`INVALID_INPUT`
200
+
-`STORY_NOT_FOUND`
201
+
-`STORY_MISMATCH`
202
+
-`STORY_NOT_SUPPORTED`
203
+
-`CROSS_STORY_PLAN`
204
+
-`MATERIALIZATION_FAILED`
194
205
195
206
## Non-applied failure codes
196
207
@@ -209,6 +220,9 @@ Returns a TextMutationReceipt with applied status; receipt reports NO_OP if the
209
220
"$ref": "#/$defs/DeleteBehavior",
210
221
"description": "Delete behavior: 'selection' (default) or 'exact'."
211
222
},
223
+
"in": {
224
+
"$ref": "#/$defs/StoryLocator"
225
+
},
212
226
"target": {
213
227
"$ref": "#/$defs/SelectionTarget",
214
228
"description": "Selection target: {kind:'selection', start:{kind:'text', blockId, offset}, end:{kind:'text', blockId, offset}}. Use 'ref' instead when you have a search result handle."
@@ -226,6 +240,9 @@ Returns a TextMutationReceipt with applied status; receipt reports NO_OP if the
226
240
"$ref": "#/$defs/DeleteBehavior",
227
241
"description": "Delete behavior: 'selection' (default) or 'exact'."
228
242
},
243
+
"in": {
244
+
"$ref": "#/$defs/StoryLocator"
245
+
},
229
246
"ref": {
230
247
"description": "Handle ref string from a superdoc_search result. Pass the handle.ref value directly (e.g. 'text:eyJ...'). Preferred over 'target' for inline formatting.",
Copy file name to clipboardExpand all lines: apps/docs/document-api/reference/format/apply.mdx
+17Lines changed: 17 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,6 +30,7 @@ Returns a TextMutationReceipt confirming inline styles were applied to the targe
30
30
31
31
| Field | Type | Required | Description |
32
32
| --- | --- | --- | --- |
33
+
|`in`| StoryLocator | no | StoryLocator |
33
34
|`inline`| object | yes ||
34
35
|`inline.bCs`| boolean \\| null | no | One of: boolean, null |
35
36
|`inline.bold`| boolean \\| null | no | One of: boolean, null |
@@ -83,6 +84,7 @@ Returns a TextMutationReceipt confirming inline styles were applied to the targe
83
84
84
85
| Field | Type | Required | Description |
85
86
| --- | --- | --- | --- |
87
+
|`in`| StoryLocator | no | StoryLocator |
86
88
|`inline`| object | yes ||
87
89
|`inline.bCs`| boolean \\| null | no | One of: boolean, null |
88
90
|`inline.bold`| boolean \\| null | no | One of: boolean, null |
@@ -133,6 +135,10 @@ Returns a TextMutationReceipt confirming inline styles were applied to the targe
133
135
134
136
```json
135
137
{
138
+
"in": {
139
+
"kind": "story",
140
+
"storyType": "body"
141
+
},
136
142
"inline": {
137
143
"bold": true,
138
144
"italic": true
@@ -280,6 +286,11 @@ Returns a TextMutationReceipt confirming inline styles were applied to the targe
280
286
-`CAPABILITY_UNAVAILABLE`
281
287
-`INVALID_TARGET`
282
288
-`INVALID_INPUT`
289
+
-`STORY_NOT_FOUND`
290
+
-`STORY_MISMATCH`
291
+
-`STORY_NOT_SUPPORTED`
292
+
-`CROSS_STORY_PLAN`
293
+
-`MATERIALIZATION_FAILED`
283
294
284
295
## Non-applied failure codes
285
296
@@ -294,6 +305,9 @@ Returns a TextMutationReceipt confirming inline styles were applied to the targe
294
305
{
295
306
"additionalProperties": false,
296
307
"properties": {
308
+
"in": {
309
+
"$ref": "#/$defs/StoryLocator"
310
+
},
297
311
"inline": {
298
312
"additionalProperties": false,
299
313
"description": "Inline formatting properties to apply. Set a property to apply it, use null to clear it. Example: {bold: true, italic: true} or {bold: null} to remove bold.",
@@ -1118,6 +1132,9 @@ Returns a TextMutationReceipt confirming inline styles were applied to the targe
1118
1132
{
1119
1133
"additionalProperties": false,
1120
1134
"properties": {
1135
+
"in": {
1136
+
"$ref": "#/$defs/StoryLocator"
1137
+
},
1121
1138
"inline": {
1122
1139
"additionalProperties": false,
1123
1140
"description": "Inline formatting properties to apply. Set a property to apply it, use null to clear it. Example: {bold: true, italic: true} or {bold: null} to remove bold.",
0 commit comments