@superdoc-dev/sdk 1.0.0-next.73 → 1.0.0-next.75
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +28 -21
- package/dist/generated/client.cjs +476 -0
- package/dist/generated/client.d.ts +9049 -147
- package/dist/generated/client.d.ts.map +1 -1
- package/dist/generated/client.js +475 -0
- package/dist/generated/contract.cjs +1338 -287
- package/dist/generated/contract.d.ts.map +1 -1
- package/dist/generated/contract.js +1338 -287
- package/dist/generated/intent-dispatch.generated.cjs +1 -0
- package/dist/generated/intent-dispatch.generated.d.ts.map +1 -1
- package/dist/generated/intent-dispatch.generated.js +1 -0
- package/dist/helpers/format.d.ts +6 -8
- package/dist/helpers/format.d.ts.map +1 -1
- package/dist/helpers/format.js +5 -8
- package/dist/index.cjs +130 -8
- package/dist/index.d.ts +73 -8
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +130 -8
- package/dist/runtime/process.d.ts +2 -2
- package/dist/runtime/process.d.ts.map +1 -1
- package/dist/runtime/transport-common.d.ts +7 -0
- package/dist/runtime/transport-common.d.ts.map +1 -1
- package/dist/tools.cjs +19 -6
- package/dist/tools.d.ts +8 -3
- package/dist/tools.d.ts.map +1 -1
- package/dist/tools.js +19 -6
- package/package.json +6 -6
- package/tools/__pycache__/__init__.cpython-312.pyc +0 -0
- package/tools/__pycache__/intent_dispatch_generated.cpython-312.pyc +0 -0
- package/tools/catalog.json +100 -1039
- package/tools/intent_dispatch_generated.py +2 -0
- package/tools/system-prompt.md +47 -11
- package/tools/tools-policy.json +1 -1
- package/tools/tools.anthropic.json +96 -1039
- package/tools/tools.generic.json +99 -1041
- package/tools/tools.openai.json +96 -1039
- package/tools/tools.vercel.json +96 -1039
package/tools/tools.generic.json
CHANGED
|
@@ -3,177 +3,49 @@
|
|
|
3
3
|
"tools": [
|
|
4
4
|
{
|
|
5
5
|
"name": "superdoc_get_content",
|
|
6
|
-
"description": "Read document content
|
|
6
|
+
"description": "Read document content. Use action \"info\" for structure and styles, \"blocks\" for all block IDs and types, \"text\" or \"markdown\" for content. Call info or blocks before editing.",
|
|
7
7
|
"parameters": {
|
|
8
8
|
"type": "object",
|
|
9
9
|
"properties": {
|
|
10
10
|
"action": {
|
|
11
11
|
"type": "string",
|
|
12
12
|
"enum": [
|
|
13
|
+
"blocks",
|
|
13
14
|
"html",
|
|
14
15
|
"info",
|
|
15
16
|
"markdown",
|
|
16
17
|
"text"
|
|
17
18
|
],
|
|
18
|
-
"description": "The action to perform. One of: html, info, markdown, text."
|
|
19
|
+
"description": "The action to perform. One of: blocks, html, info, markdown, text."
|
|
19
20
|
},
|
|
20
|
-
"
|
|
21
|
-
"type": "
|
|
22
|
-
"description": "
|
|
21
|
+
"unflattenLists": {
|
|
22
|
+
"type": "boolean",
|
|
23
|
+
"description": "When true, flattens nested list structures in output. Default: false. Only for action 'html'. Omit for other actions."
|
|
23
24
|
},
|
|
24
|
-
"
|
|
25
|
-
"type": "
|
|
26
|
-
"description": "
|
|
25
|
+
"offset": {
|
|
26
|
+
"type": "number",
|
|
27
|
+
"description": "Number of blocks to skip. Default: 0. Only for action 'blocks'. Omit for other actions."
|
|
27
28
|
},
|
|
28
|
-
"
|
|
29
|
-
"
|
|
30
|
-
|
|
31
|
-
"type": "object",
|
|
32
|
-
"properties": {
|
|
33
|
-
"kind": {
|
|
34
|
-
"const": "story",
|
|
35
|
-
"type": "string"
|
|
36
|
-
},
|
|
37
|
-
"storyType": {
|
|
38
|
-
"const": "body",
|
|
39
|
-
"type": "string"
|
|
40
|
-
}
|
|
41
|
-
},
|
|
42
|
-
"required": [
|
|
43
|
-
"kind",
|
|
44
|
-
"storyType"
|
|
45
|
-
]
|
|
46
|
-
},
|
|
47
|
-
{
|
|
48
|
-
"type": "object",
|
|
49
|
-
"properties": {
|
|
50
|
-
"kind": {
|
|
51
|
-
"const": "story",
|
|
52
|
-
"type": "string"
|
|
53
|
-
},
|
|
54
|
-
"storyType": {
|
|
55
|
-
"const": "headerFooterSlot",
|
|
56
|
-
"type": "string"
|
|
57
|
-
},
|
|
58
|
-
"section": {
|
|
59
|
-
"type": "object",
|
|
60
|
-
"properties": {
|
|
61
|
-
"kind": {
|
|
62
|
-
"const": "section",
|
|
63
|
-
"type": "string"
|
|
64
|
-
},
|
|
65
|
-
"sectionId": {
|
|
66
|
-
"type": "string"
|
|
67
|
-
}
|
|
68
|
-
},
|
|
69
|
-
"required": [
|
|
70
|
-
"kind",
|
|
71
|
-
"sectionId"
|
|
72
|
-
]
|
|
73
|
-
},
|
|
74
|
-
"headerFooterKind": {
|
|
75
|
-
"enum": [
|
|
76
|
-
"header",
|
|
77
|
-
"footer"
|
|
78
|
-
]
|
|
79
|
-
},
|
|
80
|
-
"variant": {
|
|
81
|
-
"enum": [
|
|
82
|
-
"default",
|
|
83
|
-
"first",
|
|
84
|
-
"even"
|
|
85
|
-
]
|
|
86
|
-
},
|
|
87
|
-
"resolution": {
|
|
88
|
-
"enum": [
|
|
89
|
-
"effective",
|
|
90
|
-
"explicit"
|
|
91
|
-
]
|
|
92
|
-
},
|
|
93
|
-
"onWrite": {
|
|
94
|
-
"enum": [
|
|
95
|
-
"materializeIfInherited",
|
|
96
|
-
"editResolvedPart",
|
|
97
|
-
"error"
|
|
98
|
-
]
|
|
99
|
-
}
|
|
100
|
-
},
|
|
101
|
-
"required": [
|
|
102
|
-
"kind",
|
|
103
|
-
"storyType",
|
|
104
|
-
"section",
|
|
105
|
-
"headerFooterKind",
|
|
106
|
-
"variant"
|
|
107
|
-
]
|
|
108
|
-
},
|
|
109
|
-
{
|
|
110
|
-
"type": "object",
|
|
111
|
-
"properties": {
|
|
112
|
-
"kind": {
|
|
113
|
-
"const": "story",
|
|
114
|
-
"type": "string"
|
|
115
|
-
},
|
|
116
|
-
"storyType": {
|
|
117
|
-
"const": "headerFooterPart",
|
|
118
|
-
"type": "string"
|
|
119
|
-
},
|
|
120
|
-
"refId": {
|
|
121
|
-
"type": "string"
|
|
122
|
-
}
|
|
123
|
-
},
|
|
124
|
-
"required": [
|
|
125
|
-
"kind",
|
|
126
|
-
"storyType",
|
|
127
|
-
"refId"
|
|
128
|
-
]
|
|
129
|
-
},
|
|
130
|
-
{
|
|
131
|
-
"type": "object",
|
|
132
|
-
"properties": {
|
|
133
|
-
"kind": {
|
|
134
|
-
"const": "story",
|
|
135
|
-
"type": "string"
|
|
136
|
-
},
|
|
137
|
-
"storyType": {
|
|
138
|
-
"const": "footnote",
|
|
139
|
-
"type": "string"
|
|
140
|
-
},
|
|
141
|
-
"noteId": {
|
|
142
|
-
"type": "string"
|
|
143
|
-
}
|
|
144
|
-
},
|
|
145
|
-
"required": [
|
|
146
|
-
"kind",
|
|
147
|
-
"storyType",
|
|
148
|
-
"noteId"
|
|
149
|
-
]
|
|
150
|
-
},
|
|
151
|
-
{
|
|
152
|
-
"type": "object",
|
|
153
|
-
"properties": {
|
|
154
|
-
"kind": {
|
|
155
|
-
"const": "story",
|
|
156
|
-
"type": "string"
|
|
157
|
-
},
|
|
158
|
-
"storyType": {
|
|
159
|
-
"const": "endnote",
|
|
160
|
-
"type": "string"
|
|
161
|
-
},
|
|
162
|
-
"noteId": {
|
|
163
|
-
"type": "string"
|
|
164
|
-
}
|
|
165
|
-
},
|
|
166
|
-
"required": [
|
|
167
|
-
"kind",
|
|
168
|
-
"storyType",
|
|
169
|
-
"noteId"
|
|
170
|
-
]
|
|
171
|
-
}
|
|
172
|
-
]
|
|
29
|
+
"limit": {
|
|
30
|
+
"type": "number",
|
|
31
|
+
"description": "Maximum blocks to return. Omit for all blocks. Only for action 'blocks'. Omit for other actions."
|
|
173
32
|
},
|
|
174
|
-
"
|
|
175
|
-
"type": "
|
|
176
|
-
"
|
|
33
|
+
"nodeTypes": {
|
|
34
|
+
"type": "array",
|
|
35
|
+
"items": {
|
|
36
|
+
"enum": [
|
|
37
|
+
"paragraph",
|
|
38
|
+
"heading",
|
|
39
|
+
"listItem",
|
|
40
|
+
"table",
|
|
41
|
+
"tableRow",
|
|
42
|
+
"tableCell",
|
|
43
|
+
"tableOfContents",
|
|
44
|
+
"image",
|
|
45
|
+
"sdt"
|
|
46
|
+
]
|
|
47
|
+
},
|
|
48
|
+
"description": "Filter by block types (e.g. ['paragraph', 'heading']). Omit for all types. Only for action 'blocks'. Omit for other actions."
|
|
177
49
|
}
|
|
178
50
|
},
|
|
179
51
|
"required": [
|
|
@@ -183,12 +55,13 @@
|
|
|
183
55
|
},
|
|
184
56
|
"metadata": {
|
|
185
57
|
"mutates": false,
|
|
186
|
-
"operationCount":
|
|
58
|
+
"operationCount": 5,
|
|
187
59
|
"operations": [
|
|
188
60
|
"doc.getText",
|
|
189
61
|
"doc.getMarkdown",
|
|
190
62
|
"doc.getHtml",
|
|
191
|
-
"doc.info"
|
|
63
|
+
"doc.info",
|
|
64
|
+
"doc.blocks.list"
|
|
192
65
|
]
|
|
193
66
|
}
|
|
194
67
|
},
|
|
@@ -209,14 +82,6 @@
|
|
|
209
82
|
],
|
|
210
83
|
"description": "The action to perform. One of: delete, insert, redo, replace, undo."
|
|
211
84
|
},
|
|
212
|
-
"doc": {
|
|
213
|
-
"type": "string",
|
|
214
|
-
"description": "Document path. Optional when a session is already open."
|
|
215
|
-
},
|
|
216
|
-
"sessionId": {
|
|
217
|
-
"type": "string",
|
|
218
|
-
"description": "Session ID for multi-session workflows. Optional when only one session is open."
|
|
219
|
-
},
|
|
220
85
|
"force": {
|
|
221
86
|
"type": "boolean",
|
|
222
87
|
"description": "Bypass confirmation checks."
|
|
@@ -426,159 +291,13 @@
|
|
|
426
291
|
],
|
|
427
292
|
"description": "Target address object. Use 'ref' instead if you have a search handle. Format: {kind:'text', blockId, range:{start,end}} or {kind:'block', nodeType, nodeId}."
|
|
428
293
|
},
|
|
429
|
-
"in": {
|
|
430
|
-
"oneOf": [
|
|
431
|
-
{
|
|
432
|
-
"type": "object",
|
|
433
|
-
"properties": {
|
|
434
|
-
"kind": {
|
|
435
|
-
"const": "story",
|
|
436
|
-
"type": "string"
|
|
437
|
-
},
|
|
438
|
-
"storyType": {
|
|
439
|
-
"const": "body",
|
|
440
|
-
"type": "string"
|
|
441
|
-
}
|
|
442
|
-
},
|
|
443
|
-
"required": [
|
|
444
|
-
"kind",
|
|
445
|
-
"storyType"
|
|
446
|
-
]
|
|
447
|
-
},
|
|
448
|
-
{
|
|
449
|
-
"type": "object",
|
|
450
|
-
"properties": {
|
|
451
|
-
"kind": {
|
|
452
|
-
"const": "story",
|
|
453
|
-
"type": "string"
|
|
454
|
-
},
|
|
455
|
-
"storyType": {
|
|
456
|
-
"const": "headerFooterSlot",
|
|
457
|
-
"type": "string"
|
|
458
|
-
},
|
|
459
|
-
"section": {
|
|
460
|
-
"type": "object",
|
|
461
|
-
"properties": {
|
|
462
|
-
"kind": {
|
|
463
|
-
"const": "section",
|
|
464
|
-
"type": "string"
|
|
465
|
-
},
|
|
466
|
-
"sectionId": {
|
|
467
|
-
"type": "string"
|
|
468
|
-
}
|
|
469
|
-
},
|
|
470
|
-
"required": [
|
|
471
|
-
"kind",
|
|
472
|
-
"sectionId"
|
|
473
|
-
]
|
|
474
|
-
},
|
|
475
|
-
"headerFooterKind": {
|
|
476
|
-
"enum": [
|
|
477
|
-
"header",
|
|
478
|
-
"footer"
|
|
479
|
-
]
|
|
480
|
-
},
|
|
481
|
-
"variant": {
|
|
482
|
-
"enum": [
|
|
483
|
-
"default",
|
|
484
|
-
"first",
|
|
485
|
-
"even"
|
|
486
|
-
]
|
|
487
|
-
},
|
|
488
|
-
"resolution": {
|
|
489
|
-
"enum": [
|
|
490
|
-
"effective",
|
|
491
|
-
"explicit"
|
|
492
|
-
]
|
|
493
|
-
},
|
|
494
|
-
"onWrite": {
|
|
495
|
-
"enum": [
|
|
496
|
-
"materializeIfInherited",
|
|
497
|
-
"editResolvedPart",
|
|
498
|
-
"error"
|
|
499
|
-
]
|
|
500
|
-
}
|
|
501
|
-
},
|
|
502
|
-
"required": [
|
|
503
|
-
"kind",
|
|
504
|
-
"storyType",
|
|
505
|
-
"section",
|
|
506
|
-
"headerFooterKind",
|
|
507
|
-
"variant"
|
|
508
|
-
]
|
|
509
|
-
},
|
|
510
|
-
{
|
|
511
|
-
"type": "object",
|
|
512
|
-
"properties": {
|
|
513
|
-
"kind": {
|
|
514
|
-
"const": "story",
|
|
515
|
-
"type": "string"
|
|
516
|
-
},
|
|
517
|
-
"storyType": {
|
|
518
|
-
"const": "headerFooterPart",
|
|
519
|
-
"type": "string"
|
|
520
|
-
},
|
|
521
|
-
"refId": {
|
|
522
|
-
"type": "string"
|
|
523
|
-
}
|
|
524
|
-
},
|
|
525
|
-
"required": [
|
|
526
|
-
"kind",
|
|
527
|
-
"storyType",
|
|
528
|
-
"refId"
|
|
529
|
-
]
|
|
530
|
-
},
|
|
531
|
-
{
|
|
532
|
-
"type": "object",
|
|
533
|
-
"properties": {
|
|
534
|
-
"kind": {
|
|
535
|
-
"const": "story",
|
|
536
|
-
"type": "string"
|
|
537
|
-
},
|
|
538
|
-
"storyType": {
|
|
539
|
-
"const": "footnote",
|
|
540
|
-
"type": "string"
|
|
541
|
-
},
|
|
542
|
-
"noteId": {
|
|
543
|
-
"type": "string"
|
|
544
|
-
}
|
|
545
|
-
},
|
|
546
|
-
"required": [
|
|
547
|
-
"kind",
|
|
548
|
-
"storyType",
|
|
549
|
-
"noteId"
|
|
550
|
-
]
|
|
551
|
-
},
|
|
552
|
-
{
|
|
553
|
-
"type": "object",
|
|
554
|
-
"properties": {
|
|
555
|
-
"kind": {
|
|
556
|
-
"const": "story",
|
|
557
|
-
"type": "string"
|
|
558
|
-
},
|
|
559
|
-
"storyType": {
|
|
560
|
-
"const": "endnote",
|
|
561
|
-
"type": "string"
|
|
562
|
-
},
|
|
563
|
-
"noteId": {
|
|
564
|
-
"type": "string"
|
|
565
|
-
}
|
|
566
|
-
},
|
|
567
|
-
"required": [
|
|
568
|
-
"kind",
|
|
569
|
-
"storyType",
|
|
570
|
-
"noteId"
|
|
571
|
-
]
|
|
572
|
-
}
|
|
573
|
-
]
|
|
574
|
-
},
|
|
575
294
|
"value": {
|
|
576
295
|
"type": "string",
|
|
577
|
-
"description": "Text content to insert."
|
|
296
|
+
"description": "Text content to insert. Only for action 'insert'. Omit for other actions."
|
|
578
297
|
},
|
|
579
298
|
"type": {
|
|
580
299
|
"type": "string",
|
|
581
|
-
"description": "Content format: 'text' (default), 'markdown', or 'html'.",
|
|
300
|
+
"description": "Content format: 'text' (default), 'markdown', or 'html'. Only for action 'insert'. Omit for other actions.",
|
|
582
301
|
"enum": [
|
|
583
302
|
"text",
|
|
584
303
|
"markdown",
|
|
@@ -603,11 +322,11 @@
|
|
|
603
322
|
}
|
|
604
323
|
}
|
|
605
324
|
],
|
|
606
|
-
"description": "Document fragment to insert (structured content)."
|
|
325
|
+
"description": "Document fragment to insert (structured content). Only for actions 'insert', 'replace'. Omit for other actions."
|
|
607
326
|
},
|
|
608
327
|
"placement": {
|
|
609
328
|
"type": "string",
|
|
610
|
-
"description": "Where to place content relative to target: 'before', 'after', 'insideStart', or 'insideEnd'.",
|
|
329
|
+
"description": "Where to place content relative to target: 'before', 'after', 'insideStart', or 'insideEnd'. Only for action 'insert'. Omit for other actions.",
|
|
611
330
|
"enum": [
|
|
612
331
|
"before",
|
|
613
332
|
"after",
|
|
@@ -625,7 +344,7 @@
|
|
|
625
344
|
]
|
|
626
345
|
}
|
|
627
346
|
},
|
|
628
|
-
"description": "Controls nesting behavior. tables: 'allow' permits inserting tables inside other tables."
|
|
347
|
+
"description": "Controls nesting behavior. tables: 'allow' permits inserting tables inside other tables. Only for actions 'insert', 'replace'. Omit for other actions."
|
|
629
348
|
},
|
|
630
349
|
"blockId": {
|
|
631
350
|
"type": "string",
|
|
@@ -641,11 +360,11 @@
|
|
|
641
360
|
},
|
|
642
361
|
"offset": {
|
|
643
362
|
"type": "number",
|
|
644
|
-
"description": "Character offset for insertion (alias for --start/--end with same value)."
|
|
363
|
+
"description": "Character offset for insertion (alias for --start/--end with same value). Only for action 'insert'. Omit for other actions."
|
|
645
364
|
},
|
|
646
365
|
"text": {
|
|
647
366
|
"type": "string",
|
|
648
|
-
"description": "Replacement text content."
|
|
367
|
+
"description": "Replacement text content. Only for action 'replace'. Omit for other actions."
|
|
649
368
|
},
|
|
650
369
|
"behavior": {
|
|
651
370
|
"type": "string",
|
|
@@ -653,7 +372,7 @@
|
|
|
653
372
|
"selection",
|
|
654
373
|
"exact"
|
|
655
374
|
],
|
|
656
|
-
"description": "Delete behavior: 'selection' (default) or 'exact'."
|
|
375
|
+
"description": "Delete behavior: 'selection' (default) or 'exact'. Only for action 'delete'. Omit for other actions."
|
|
657
376
|
}
|
|
658
377
|
},
|
|
659
378
|
"required": [
|
|
@@ -675,7 +394,7 @@
|
|
|
675
394
|
},
|
|
676
395
|
{
|
|
677
396
|
"name": "superdoc_format",
|
|
678
|
-
"description": "Change text and paragraph formatting",
|
|
397
|
+
"description": "Change text and paragraph formatting. Use action \"inline\" with a search ref for bold/italic/etc. Use action \"set_style\" with a styleId from superdoc_get_content info to apply a named paragraph style.",
|
|
679
398
|
"parameters": {
|
|
680
399
|
"type": "object",
|
|
681
400
|
"properties": {
|
|
@@ -691,14 +410,6 @@
|
|
|
691
410
|
],
|
|
692
411
|
"description": "The action to perform. One of: inline, set_alignment, set_direction, set_indentation, set_spacing, set_style."
|
|
693
412
|
},
|
|
694
|
-
"doc": {
|
|
695
|
-
"type": "string",
|
|
696
|
-
"description": "Document path. Optional when a session is already open."
|
|
697
|
-
},
|
|
698
|
-
"sessionId": {
|
|
699
|
-
"type": "string",
|
|
700
|
-
"description": "Session ID for multi-session workflows. Optional when only one session is open."
|
|
701
|
-
},
|
|
702
413
|
"force": {
|
|
703
414
|
"type": "boolean",
|
|
704
415
|
"description": "Bypass confirmation checks."
|
|
@@ -874,152 +585,6 @@
|
|
|
874
585
|
],
|
|
875
586
|
"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. Required for actions 'set_style', 'set_alignment', 'set_indentation', 'set_spacing', 'set_direction'."
|
|
876
587
|
},
|
|
877
|
-
"in": {
|
|
878
|
-
"oneOf": [
|
|
879
|
-
{
|
|
880
|
-
"type": "object",
|
|
881
|
-
"properties": {
|
|
882
|
-
"kind": {
|
|
883
|
-
"const": "story",
|
|
884
|
-
"type": "string"
|
|
885
|
-
},
|
|
886
|
-
"storyType": {
|
|
887
|
-
"const": "body",
|
|
888
|
-
"type": "string"
|
|
889
|
-
}
|
|
890
|
-
},
|
|
891
|
-
"required": [
|
|
892
|
-
"kind",
|
|
893
|
-
"storyType"
|
|
894
|
-
]
|
|
895
|
-
},
|
|
896
|
-
{
|
|
897
|
-
"type": "object",
|
|
898
|
-
"properties": {
|
|
899
|
-
"kind": {
|
|
900
|
-
"const": "story",
|
|
901
|
-
"type": "string"
|
|
902
|
-
},
|
|
903
|
-
"storyType": {
|
|
904
|
-
"const": "headerFooterSlot",
|
|
905
|
-
"type": "string"
|
|
906
|
-
},
|
|
907
|
-
"section": {
|
|
908
|
-
"type": "object",
|
|
909
|
-
"properties": {
|
|
910
|
-
"kind": {
|
|
911
|
-
"const": "section",
|
|
912
|
-
"type": "string"
|
|
913
|
-
},
|
|
914
|
-
"sectionId": {
|
|
915
|
-
"type": "string"
|
|
916
|
-
}
|
|
917
|
-
},
|
|
918
|
-
"required": [
|
|
919
|
-
"kind",
|
|
920
|
-
"sectionId"
|
|
921
|
-
]
|
|
922
|
-
},
|
|
923
|
-
"headerFooterKind": {
|
|
924
|
-
"enum": [
|
|
925
|
-
"header",
|
|
926
|
-
"footer"
|
|
927
|
-
]
|
|
928
|
-
},
|
|
929
|
-
"variant": {
|
|
930
|
-
"enum": [
|
|
931
|
-
"default",
|
|
932
|
-
"first",
|
|
933
|
-
"even"
|
|
934
|
-
]
|
|
935
|
-
},
|
|
936
|
-
"resolution": {
|
|
937
|
-
"enum": [
|
|
938
|
-
"effective",
|
|
939
|
-
"explicit"
|
|
940
|
-
]
|
|
941
|
-
},
|
|
942
|
-
"onWrite": {
|
|
943
|
-
"enum": [
|
|
944
|
-
"materializeIfInherited",
|
|
945
|
-
"editResolvedPart",
|
|
946
|
-
"error"
|
|
947
|
-
]
|
|
948
|
-
}
|
|
949
|
-
},
|
|
950
|
-
"required": [
|
|
951
|
-
"kind",
|
|
952
|
-
"storyType",
|
|
953
|
-
"section",
|
|
954
|
-
"headerFooterKind",
|
|
955
|
-
"variant"
|
|
956
|
-
]
|
|
957
|
-
},
|
|
958
|
-
{
|
|
959
|
-
"type": "object",
|
|
960
|
-
"properties": {
|
|
961
|
-
"kind": {
|
|
962
|
-
"const": "story",
|
|
963
|
-
"type": "string"
|
|
964
|
-
},
|
|
965
|
-
"storyType": {
|
|
966
|
-
"const": "headerFooterPart",
|
|
967
|
-
"type": "string"
|
|
968
|
-
},
|
|
969
|
-
"refId": {
|
|
970
|
-
"type": "string"
|
|
971
|
-
}
|
|
972
|
-
},
|
|
973
|
-
"required": [
|
|
974
|
-
"kind",
|
|
975
|
-
"storyType",
|
|
976
|
-
"refId"
|
|
977
|
-
]
|
|
978
|
-
},
|
|
979
|
-
{
|
|
980
|
-
"type": "object",
|
|
981
|
-
"properties": {
|
|
982
|
-
"kind": {
|
|
983
|
-
"const": "story",
|
|
984
|
-
"type": "string"
|
|
985
|
-
},
|
|
986
|
-
"storyType": {
|
|
987
|
-
"const": "footnote",
|
|
988
|
-
"type": "string"
|
|
989
|
-
},
|
|
990
|
-
"noteId": {
|
|
991
|
-
"type": "string"
|
|
992
|
-
}
|
|
993
|
-
},
|
|
994
|
-
"required": [
|
|
995
|
-
"kind",
|
|
996
|
-
"storyType",
|
|
997
|
-
"noteId"
|
|
998
|
-
]
|
|
999
|
-
},
|
|
1000
|
-
{
|
|
1001
|
-
"type": "object",
|
|
1002
|
-
"properties": {
|
|
1003
|
-
"kind": {
|
|
1004
|
-
"const": "story",
|
|
1005
|
-
"type": "string"
|
|
1006
|
-
},
|
|
1007
|
-
"storyType": {
|
|
1008
|
-
"const": "endnote",
|
|
1009
|
-
"type": "string"
|
|
1010
|
-
},
|
|
1011
|
-
"noteId": {
|
|
1012
|
-
"type": "string"
|
|
1013
|
-
}
|
|
1014
|
-
},
|
|
1015
|
-
"required": [
|
|
1016
|
-
"kind",
|
|
1017
|
-
"storyType",
|
|
1018
|
-
"noteId"
|
|
1019
|
-
]
|
|
1020
|
-
}
|
|
1021
|
-
]
|
|
1022
|
-
},
|
|
1023
588
|
"inline": {
|
|
1024
589
|
"type": "object",
|
|
1025
590
|
"properties": {
|
|
@@ -1279,27 +844,15 @@
|
|
|
1279
844
|
"type": "boolean"
|
|
1280
845
|
}
|
|
1281
846
|
},
|
|
1282
|
-
"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."
|
|
847
|
+
"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. Only for action 'inline'. Omit for other actions."
|
|
1283
848
|
},
|
|
1284
849
|
"ref": {
|
|
1285
850
|
"type": "string",
|
|
1286
|
-
"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."
|
|
1287
|
-
},
|
|
1288
|
-
"blockId": {
|
|
1289
|
-
"type": "string",
|
|
1290
|
-
"description": "Block ID of the target paragraph."
|
|
1291
|
-
},
|
|
1292
|
-
"start": {
|
|
1293
|
-
"type": "number",
|
|
1294
|
-
"description": "Start offset within the block (character index)."
|
|
1295
|
-
},
|
|
1296
|
-
"end": {
|
|
1297
|
-
"type": "number",
|
|
1298
|
-
"description": "End offset within the block (character index)."
|
|
851
|
+
"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. Only for action 'inline'. Omit for other actions."
|
|
1299
852
|
},
|
|
1300
853
|
"styleId": {
|
|
1301
854
|
"type": "string",
|
|
1302
|
-
"description": "Required for action 'set_style'."
|
|
855
|
+
"description": "Named paragraph style ID (e.g. 'Normal', 'Heading1', 'BodyText'). Use superdoc_search to find a nearby paragraph, then inspect its style to determine the correct styleId. Required for action 'set_style'."
|
|
1303
856
|
},
|
|
1304
857
|
"alignment": {
|
|
1305
858
|
"type": "string",
|
|
@@ -1313,35 +866,35 @@
|
|
|
1313
866
|
},
|
|
1314
867
|
"left": {
|
|
1315
868
|
"type": "number",
|
|
1316
|
-
"description": "Left indentation in twips (1440 = 1 inch)."
|
|
869
|
+
"description": "Left indentation in twips (1440 = 1 inch). Only for action 'set_indentation'. Omit for other actions."
|
|
1317
870
|
},
|
|
1318
871
|
"right": {
|
|
1319
872
|
"type": "number",
|
|
1320
|
-
"description": "Right indentation in twips (1440 = 1 inch)."
|
|
873
|
+
"description": "Right indentation in twips (1440 = 1 inch). Only for action 'set_indentation'. Omit for other actions."
|
|
1321
874
|
},
|
|
1322
875
|
"firstLine": {
|
|
1323
876
|
"type": "number",
|
|
1324
|
-
"description": "First line indent in twips. Cannot be combined with hanging."
|
|
877
|
+
"description": "First line indent in twips. Cannot be combined with hanging. Only for action 'set_indentation'. Omit for other actions."
|
|
1325
878
|
},
|
|
1326
879
|
"hanging": {
|
|
1327
880
|
"type": "number",
|
|
1328
|
-
"description": "Hanging indent in twips. Cannot be combined with firstLine."
|
|
881
|
+
"description": "Hanging indent in twips. Cannot be combined with firstLine. Only for action 'set_indentation'. Omit for other actions."
|
|
1329
882
|
},
|
|
1330
883
|
"before": {
|
|
1331
884
|
"type": "number",
|
|
1332
|
-
"description": "Space before paragraph in twips (20 twips = 1pt)."
|
|
885
|
+
"description": "Space before paragraph in twips (20 twips = 1pt). Only for action 'set_spacing'. Omit for other actions."
|
|
1333
886
|
},
|
|
1334
887
|
"after": {
|
|
1335
888
|
"type": "number",
|
|
1336
|
-
"description": "Space after paragraph in twips (20 twips = 1pt)."
|
|
889
|
+
"description": "Space after paragraph in twips (20 twips = 1pt). Only for action 'set_spacing'. Omit for other actions."
|
|
1337
890
|
},
|
|
1338
891
|
"line": {
|
|
1339
892
|
"type": "number",
|
|
1340
|
-
"description": "Line spacing value. Meaning depends on lineRule. Must be provided together with lineRule."
|
|
893
|
+
"description": "Line spacing value. Meaning depends on lineRule. Must be provided together with lineRule. Only for action 'set_spacing'. Omit for other actions."
|
|
1341
894
|
},
|
|
1342
895
|
"lineRule": {
|
|
1343
896
|
"type": "string",
|
|
1344
|
-
"description": "Line spacing rule. Required when 'line' is set.",
|
|
897
|
+
"description": "Line spacing rule. Required when 'line' is set. Only for action 'set_spacing'. Omit for other actions.",
|
|
1345
898
|
"enum": [
|
|
1346
899
|
"auto",
|
|
1347
900
|
"exact",
|
|
@@ -1361,7 +914,8 @@
|
|
|
1361
914
|
"enum": [
|
|
1362
915
|
"preserve",
|
|
1363
916
|
"matchDirection"
|
|
1364
|
-
]
|
|
917
|
+
],
|
|
918
|
+
"description": "Only for action 'set_direction'. Omit for other actions."
|
|
1365
919
|
}
|
|
1366
920
|
},
|
|
1367
921
|
"required": [
|
|
@@ -1384,187 +938,33 @@
|
|
|
1384
938
|
},
|
|
1385
939
|
{
|
|
1386
940
|
"name": "superdoc_create",
|
|
1387
|
-
"description": "Create
|
|
941
|
+
"description": "Create one paragraph or heading per call. After creating, search for it and apply formatting (fontFamily, fontSize) from neighboring blocks. For multiple paragraphs, use superdoc_mutations with text.insert steps instead of calling create repeatedly.",
|
|
1388
942
|
"parameters": {
|
|
1389
943
|
"type": "object",
|
|
1390
944
|
"properties": {
|
|
1391
945
|
"action": {
|
|
1392
946
|
"type": "string",
|
|
1393
|
-
"enum": [
|
|
1394
|
-
"heading",
|
|
1395
|
-
"paragraph"
|
|
1396
|
-
],
|
|
1397
|
-
"description": "The action to perform. One of: heading, paragraph."
|
|
1398
|
-
},
|
|
1399
|
-
"
|
|
1400
|
-
"type": "
|
|
1401
|
-
"description": "
|
|
1402
|
-
},
|
|
1403
|
-
"
|
|
1404
|
-
"type": "string",
|
|
1405
|
-
"
|
|
1406
|
-
|
|
1407
|
-
|
|
1408
|
-
|
|
1409
|
-
"description": "
|
|
1410
|
-
},
|
|
1411
|
-
"
|
|
1412
|
-
"type": "
|
|
1413
|
-
"
|
|
1414
|
-
"direct",
|
|
1415
|
-
"tracked"
|
|
1416
|
-
],
|
|
1417
|
-
"description": "Edit mode: \"direct\" applies changes immediately, \"tracked\" records as suggestions."
|
|
1418
|
-
},
|
|
1419
|
-
"dryRun": {
|
|
1420
|
-
"type": "boolean",
|
|
1421
|
-
"description": "Preview the result without applying changes."
|
|
1422
|
-
},
|
|
1423
|
-
"in": {
|
|
1424
|
-
"oneOf": [
|
|
1425
|
-
{
|
|
1426
|
-
"type": "object",
|
|
1427
|
-
"properties": {
|
|
1428
|
-
"kind": {
|
|
1429
|
-
"const": "story",
|
|
1430
|
-
"type": "string"
|
|
1431
|
-
},
|
|
1432
|
-
"storyType": {
|
|
1433
|
-
"const": "body",
|
|
1434
|
-
"type": "string"
|
|
1435
|
-
}
|
|
1436
|
-
},
|
|
1437
|
-
"required": [
|
|
1438
|
-
"kind",
|
|
1439
|
-
"storyType"
|
|
1440
|
-
]
|
|
1441
|
-
},
|
|
1442
|
-
{
|
|
1443
|
-
"type": "object",
|
|
1444
|
-
"properties": {
|
|
1445
|
-
"kind": {
|
|
1446
|
-
"const": "story",
|
|
1447
|
-
"type": "string"
|
|
1448
|
-
},
|
|
1449
|
-
"storyType": {
|
|
1450
|
-
"const": "headerFooterSlot",
|
|
1451
|
-
"type": "string"
|
|
1452
|
-
},
|
|
1453
|
-
"section": {
|
|
1454
|
-
"type": "object",
|
|
1455
|
-
"properties": {
|
|
1456
|
-
"kind": {
|
|
1457
|
-
"const": "section",
|
|
1458
|
-
"type": "string"
|
|
1459
|
-
},
|
|
1460
|
-
"sectionId": {
|
|
1461
|
-
"type": "string"
|
|
1462
|
-
}
|
|
1463
|
-
},
|
|
1464
|
-
"required": [
|
|
1465
|
-
"kind",
|
|
1466
|
-
"sectionId"
|
|
1467
|
-
]
|
|
1468
|
-
},
|
|
1469
|
-
"headerFooterKind": {
|
|
1470
|
-
"enum": [
|
|
1471
|
-
"header",
|
|
1472
|
-
"footer"
|
|
1473
|
-
]
|
|
1474
|
-
},
|
|
1475
|
-
"variant": {
|
|
1476
|
-
"enum": [
|
|
1477
|
-
"default",
|
|
1478
|
-
"first",
|
|
1479
|
-
"even"
|
|
1480
|
-
]
|
|
1481
|
-
},
|
|
1482
|
-
"resolution": {
|
|
1483
|
-
"enum": [
|
|
1484
|
-
"effective",
|
|
1485
|
-
"explicit"
|
|
1486
|
-
]
|
|
1487
|
-
},
|
|
1488
|
-
"onWrite": {
|
|
1489
|
-
"enum": [
|
|
1490
|
-
"materializeIfInherited",
|
|
1491
|
-
"editResolvedPart",
|
|
1492
|
-
"error"
|
|
1493
|
-
]
|
|
1494
|
-
}
|
|
1495
|
-
},
|
|
1496
|
-
"required": [
|
|
1497
|
-
"kind",
|
|
1498
|
-
"storyType",
|
|
1499
|
-
"section",
|
|
1500
|
-
"headerFooterKind",
|
|
1501
|
-
"variant"
|
|
1502
|
-
]
|
|
1503
|
-
},
|
|
1504
|
-
{
|
|
1505
|
-
"type": "object",
|
|
1506
|
-
"properties": {
|
|
1507
|
-
"kind": {
|
|
1508
|
-
"const": "story",
|
|
1509
|
-
"type": "string"
|
|
1510
|
-
},
|
|
1511
|
-
"storyType": {
|
|
1512
|
-
"const": "headerFooterPart",
|
|
1513
|
-
"type": "string"
|
|
1514
|
-
},
|
|
1515
|
-
"refId": {
|
|
1516
|
-
"type": "string"
|
|
1517
|
-
}
|
|
1518
|
-
},
|
|
1519
|
-
"required": [
|
|
1520
|
-
"kind",
|
|
1521
|
-
"storyType",
|
|
1522
|
-
"refId"
|
|
1523
|
-
]
|
|
1524
|
-
},
|
|
1525
|
-
{
|
|
1526
|
-
"type": "object",
|
|
1527
|
-
"properties": {
|
|
1528
|
-
"kind": {
|
|
1529
|
-
"const": "story",
|
|
1530
|
-
"type": "string"
|
|
1531
|
-
},
|
|
1532
|
-
"storyType": {
|
|
1533
|
-
"const": "footnote",
|
|
1534
|
-
"type": "string"
|
|
1535
|
-
},
|
|
1536
|
-
"noteId": {
|
|
1537
|
-
"type": "string"
|
|
1538
|
-
}
|
|
1539
|
-
},
|
|
1540
|
-
"required": [
|
|
1541
|
-
"kind",
|
|
1542
|
-
"storyType",
|
|
1543
|
-
"noteId"
|
|
1544
|
-
]
|
|
1545
|
-
},
|
|
1546
|
-
{
|
|
1547
|
-
"type": "object",
|
|
1548
|
-
"properties": {
|
|
1549
|
-
"kind": {
|
|
1550
|
-
"const": "story",
|
|
1551
|
-
"type": "string"
|
|
1552
|
-
},
|
|
1553
|
-
"storyType": {
|
|
1554
|
-
"const": "endnote",
|
|
1555
|
-
"type": "string"
|
|
1556
|
-
},
|
|
1557
|
-
"noteId": {
|
|
1558
|
-
"type": "string"
|
|
1559
|
-
}
|
|
1560
|
-
},
|
|
1561
|
-
"required": [
|
|
1562
|
-
"kind",
|
|
1563
|
-
"storyType",
|
|
1564
|
-
"noteId"
|
|
1565
|
-
]
|
|
1566
|
-
}
|
|
1567
|
-
]
|
|
947
|
+
"enum": [
|
|
948
|
+
"heading",
|
|
949
|
+
"paragraph"
|
|
950
|
+
],
|
|
951
|
+
"description": "The action to perform. One of: heading, paragraph."
|
|
952
|
+
},
|
|
953
|
+
"force": {
|
|
954
|
+
"type": "boolean",
|
|
955
|
+
"description": "Bypass confirmation checks."
|
|
956
|
+
},
|
|
957
|
+
"changeMode": {
|
|
958
|
+
"type": "string",
|
|
959
|
+
"enum": [
|
|
960
|
+
"direct",
|
|
961
|
+
"tracked"
|
|
962
|
+
],
|
|
963
|
+
"description": "Edit mode: \"direct\" applies changes immediately, \"tracked\" records as suggestions."
|
|
964
|
+
},
|
|
965
|
+
"dryRun": {
|
|
966
|
+
"type": "boolean",
|
|
967
|
+
"description": "Preview the result without applying changes."
|
|
1568
968
|
},
|
|
1569
969
|
"at": {
|
|
1570
970
|
"oneOf": [
|
|
@@ -1683,7 +1083,7 @@
|
|
|
1683
1083
|
},
|
|
1684
1084
|
"text": {
|
|
1685
1085
|
"type": "string",
|
|
1686
|
-
"description": "Paragraph text content."
|
|
1086
|
+
"description": "Paragraph text content. Each call creates ONE paragraph. For multiple items (e.g. list items), call superdoc_create separately for each item — do NOT use newlines to put multiple items in one paragraph."
|
|
1687
1087
|
},
|
|
1688
1088
|
"input": {
|
|
1689
1089
|
"type": "object",
|
|
@@ -1727,14 +1127,6 @@
|
|
|
1727
1127
|
],
|
|
1728
1128
|
"description": "The action to perform. One of: create, detach, indent, insert, outdent, set_level, set_type."
|
|
1729
1129
|
},
|
|
1730
|
-
"doc": {
|
|
1731
|
-
"type": "string",
|
|
1732
|
-
"description": "Document path. Optional when a session is already open."
|
|
1733
|
-
},
|
|
1734
|
-
"sessionId": {
|
|
1735
|
-
"type": "string",
|
|
1736
|
-
"description": "Session ID for multi-session workflows. Optional when only one session is open."
|
|
1737
|
-
},
|
|
1738
1130
|
"force": {
|
|
1739
1131
|
"type": "boolean",
|
|
1740
1132
|
"description": "Bypass confirmation checks."
|
|
@@ -1783,7 +1175,7 @@
|
|
|
1783
1175
|
},
|
|
1784
1176
|
"text": {
|
|
1785
1177
|
"type": "string",
|
|
1786
|
-
"description": "Text content for the new list item."
|
|
1178
|
+
"description": "Text content for the new list item. Only for action 'insert'. Omit for other actions."
|
|
1787
1179
|
},
|
|
1788
1180
|
"input": {
|
|
1789
1181
|
"type": "object",
|
|
@@ -1795,7 +1187,7 @@
|
|
|
1795
1187
|
},
|
|
1796
1188
|
"mode": {
|
|
1797
1189
|
"type": "string",
|
|
1798
|
-
"description": "Required.
|
|
1190
|
+
"description": "Required. 'fromParagraphs' converts existing paragraphs into list items — each paragraph becomes one item, so create one paragraph per item first. 'empty' creates a new empty list at 'at'. Required for action 'create'.",
|
|
1799
1191
|
"enum": [
|
|
1800
1192
|
"empty",
|
|
1801
1193
|
"fromParagraphs"
|
|
@@ -1821,7 +1213,7 @@
|
|
|
1821
1213
|
"nodeType",
|
|
1822
1214
|
"nodeId"
|
|
1823
1215
|
],
|
|
1824
|
-
"description": "Required when mode is 'empty'. The paragraph to create the list at. Format: {kind:'block', nodeType:'paragraph', nodeId:'<id>'}."
|
|
1216
|
+
"description": "Required when mode is 'empty'. The paragraph to create the list at. Format: {kind:'block', nodeType:'paragraph', nodeId:'<id>'}. Only for action 'create'. Omit for other actions."
|
|
1825
1217
|
},
|
|
1826
1218
|
"kind": {
|
|
1827
1219
|
"type": "string",
|
|
@@ -1837,7 +1229,7 @@
|
|
|
1837
1229
|
},
|
|
1838
1230
|
"preset": {
|
|
1839
1231
|
"type": "string",
|
|
1840
|
-
"description": "Predefined list style preset. Overrides 'kind' with a specific numbering or bullet format.",
|
|
1232
|
+
"description": "Predefined list style preset. Overrides 'kind' with a specific numbering or bullet format. Only for action 'create'. Omit for other actions.",
|
|
1841
1233
|
"enum": [
|
|
1842
1234
|
"decimal",
|
|
1843
1235
|
"decimalParenthesis",
|
|
@@ -1920,7 +1312,8 @@
|
|
|
1920
1312
|
"required": [
|
|
1921
1313
|
"version",
|
|
1922
1314
|
"levels"
|
|
1923
|
-
]
|
|
1315
|
+
],
|
|
1316
|
+
"description": "Only for action 'create'. Omit for other actions."
|
|
1924
1317
|
},
|
|
1925
1318
|
"sequence": {
|
|
1926
1319
|
"oneOf": [
|
|
@@ -1951,11 +1344,12 @@
|
|
|
1951
1344
|
"mode"
|
|
1952
1345
|
]
|
|
1953
1346
|
}
|
|
1954
|
-
]
|
|
1347
|
+
],
|
|
1348
|
+
"description": "Only for action 'create'. Omit for other actions."
|
|
1955
1349
|
},
|
|
1956
1350
|
"continuity": {
|
|
1957
1351
|
"type": "string",
|
|
1958
|
-
"description": "Numbering continuity: 'preserve' keeps numbering; 'none' restarts.",
|
|
1352
|
+
"description": "Numbering continuity: 'preserve' keeps numbering; 'none' restarts. Only for action 'set_type'. Omit for other actions.",
|
|
1959
1353
|
"enum": [
|
|
1960
1354
|
"preserve",
|
|
1961
1355
|
"none"
|
|
@@ -1998,14 +1392,6 @@
|
|
|
1998
1392
|
],
|
|
1999
1393
|
"description": "The action to perform. One of: create, delete, get, list, update."
|
|
2000
1394
|
},
|
|
2001
|
-
"doc": {
|
|
2002
|
-
"type": "string",
|
|
2003
|
-
"description": "Document path. Optional when a session is already open."
|
|
2004
|
-
},
|
|
2005
|
-
"sessionId": {
|
|
2006
|
-
"type": "string",
|
|
2007
|
-
"description": "Session ID for multi-session workflows. Optional when only one session is open."
|
|
2008
|
-
},
|
|
2009
1395
|
"force": {
|
|
2010
1396
|
"type": "boolean",
|
|
2011
1397
|
"description": "Bypass confirmation checks."
|
|
@@ -2053,23 +1439,11 @@
|
|
|
2053
1439
|
"blockId",
|
|
2054
1440
|
"range"
|
|
2055
1441
|
],
|
|
2056
|
-
"description": "Text range to anchor the comment: {kind:'text', blockId:'...', range:{start:N, end:N}}."
|
|
1442
|
+
"description": "Text range to anchor the comment: {kind:'text', blockId:'...', range:{start:N, end:N}}. Only for actions 'create', 'update'. Omit for other actions."
|
|
2057
1443
|
},
|
|
2058
1444
|
"parentId": {
|
|
2059
1445
|
"type": "string",
|
|
2060
|
-
"description": "Parent comment ID for creating a threaded reply."
|
|
2061
|
-
},
|
|
2062
|
-
"blockId": {
|
|
2063
|
-
"type": "string",
|
|
2064
|
-
"description": "Block ID of the target paragraph."
|
|
2065
|
-
},
|
|
2066
|
-
"start": {
|
|
2067
|
-
"type": "number",
|
|
2068
|
-
"description": "Start offset within the block (character index)."
|
|
2069
|
-
},
|
|
2070
|
-
"end": {
|
|
2071
|
-
"type": "number",
|
|
2072
|
-
"description": "End offset within the block (character index)."
|
|
1446
|
+
"description": "Parent comment ID for creating a threaded reply. Only for action 'create'. Omit for other actions."
|
|
2073
1447
|
},
|
|
2074
1448
|
"id": {
|
|
2075
1449
|
"type": "string",
|
|
@@ -2077,26 +1451,26 @@
|
|
|
2077
1451
|
},
|
|
2078
1452
|
"status": {
|
|
2079
1453
|
"type": "string",
|
|
2080
|
-
"description": "Set comment status. Use 'resolved' to mark as resolved.",
|
|
1454
|
+
"description": "Set comment status. Use 'resolved' to mark as resolved. Only for action 'update'. Omit for other actions.",
|
|
2081
1455
|
"enum": [
|
|
2082
1456
|
"resolved"
|
|
2083
1457
|
]
|
|
2084
1458
|
},
|
|
2085
1459
|
"isInternal": {
|
|
2086
1460
|
"type": "boolean",
|
|
2087
|
-
"description": "When true, marks the comment as internal (hidden from external collaborators)."
|
|
1461
|
+
"description": "When true, marks the comment as internal (hidden from external collaborators). Only for action 'update'. Omit for other actions."
|
|
2088
1462
|
},
|
|
2089
1463
|
"includeResolved": {
|
|
2090
1464
|
"type": "boolean",
|
|
2091
|
-
"description": "When true, includes resolved comments in results. Default: false."
|
|
1465
|
+
"description": "When true, includes resolved comments in results. Default: false. Only for action 'list'. Omit for other actions."
|
|
2092
1466
|
},
|
|
2093
1467
|
"limit": {
|
|
2094
1468
|
"type": "number",
|
|
2095
|
-
"description": "Maximum number of comments to return."
|
|
1469
|
+
"description": "Maximum number of comments to return. Only for action 'list'. Omit for other actions."
|
|
2096
1470
|
},
|
|
2097
1471
|
"offset": {
|
|
2098
1472
|
"type": "number",
|
|
2099
|
-
"description": "Number of comments to skip for pagination."
|
|
1473
|
+
"description": "Number of comments to skip for pagination. Only for action 'list'. Omit for other actions."
|
|
2100
1474
|
}
|
|
2101
1475
|
},
|
|
2102
1476
|
"required": [
|
|
@@ -2130,25 +1504,17 @@
|
|
|
2130
1504
|
],
|
|
2131
1505
|
"description": "The action to perform. One of: decide, list."
|
|
2132
1506
|
},
|
|
2133
|
-
"doc": {
|
|
2134
|
-
"type": "string",
|
|
2135
|
-
"description": "Document path. Optional when a session is already open."
|
|
2136
|
-
},
|
|
2137
|
-
"sessionId": {
|
|
2138
|
-
"type": "string",
|
|
2139
|
-
"description": "Session ID for multi-session workflows. Optional when only one session is open."
|
|
2140
|
-
},
|
|
2141
1507
|
"limit": {
|
|
2142
1508
|
"type": "number",
|
|
2143
|
-
"description": "Maximum number of tracked changes to return."
|
|
1509
|
+
"description": "Maximum number of tracked changes to return. Only for action 'list'. Omit for other actions."
|
|
2144
1510
|
},
|
|
2145
1511
|
"offset": {
|
|
2146
1512
|
"type": "number",
|
|
2147
|
-
"description": "Number of tracked changes to skip for pagination."
|
|
1513
|
+
"description": "Number of tracked changes to skip for pagination. Only for action 'list'. Omit for other actions."
|
|
2148
1514
|
},
|
|
2149
1515
|
"type": {
|
|
2150
1516
|
"type": "string",
|
|
2151
|
-
"description": "Filter by change type: 'insert', 'delete', or 'format'.",
|
|
1517
|
+
"description": "Filter by change type: 'insert', 'delete', or 'format'. Only for action 'list'. Omit for other actions.",
|
|
2152
1518
|
"enum": [
|
|
2153
1519
|
"insert",
|
|
2154
1520
|
"delete",
|
|
@@ -2157,7 +1523,7 @@
|
|
|
2157
1523
|
},
|
|
2158
1524
|
"force": {
|
|
2159
1525
|
"type": "boolean",
|
|
2160
|
-
"description": "Bypass confirmation checks."
|
|
1526
|
+
"description": "Bypass confirmation checks. Only for action 'decide'. Omit for other actions."
|
|
2161
1527
|
},
|
|
2162
1528
|
"changeMode": {
|
|
2163
1529
|
"type": "string",
|
|
@@ -2165,7 +1531,7 @@
|
|
|
2165
1531
|
"direct",
|
|
2166
1532
|
"tracked"
|
|
2167
1533
|
],
|
|
2168
|
-
"description": "Edit mode: \"direct\" applies changes immediately, \"tracked\" records as suggestions."
|
|
1534
|
+
"description": "Edit mode: \"direct\" applies changes immediately, \"tracked\" records as suggestions. Only for action 'decide'. Omit for other actions."
|
|
2169
1535
|
},
|
|
2170
1536
|
"decision": {
|
|
2171
1537
|
"type": "string",
|
|
@@ -2225,160 +1591,6 @@
|
|
|
2225
1591
|
"parameters": {
|
|
2226
1592
|
"type": "object",
|
|
2227
1593
|
"properties": {
|
|
2228
|
-
"doc": {
|
|
2229
|
-
"type": "string",
|
|
2230
|
-
"description": "Document path. Optional when a session is already open."
|
|
2231
|
-
},
|
|
2232
|
-
"sessionId": {
|
|
2233
|
-
"type": "string",
|
|
2234
|
-
"description": "Session ID for multi-session workflows. Optional when only one session is open."
|
|
2235
|
-
},
|
|
2236
|
-
"in": {
|
|
2237
|
-
"oneOf": [
|
|
2238
|
-
{
|
|
2239
|
-
"type": "object",
|
|
2240
|
-
"properties": {
|
|
2241
|
-
"kind": {
|
|
2242
|
-
"const": "story",
|
|
2243
|
-
"type": "string"
|
|
2244
|
-
},
|
|
2245
|
-
"storyType": {
|
|
2246
|
-
"const": "body",
|
|
2247
|
-
"type": "string"
|
|
2248
|
-
}
|
|
2249
|
-
},
|
|
2250
|
-
"required": [
|
|
2251
|
-
"kind",
|
|
2252
|
-
"storyType"
|
|
2253
|
-
]
|
|
2254
|
-
},
|
|
2255
|
-
{
|
|
2256
|
-
"type": "object",
|
|
2257
|
-
"properties": {
|
|
2258
|
-
"kind": {
|
|
2259
|
-
"const": "story",
|
|
2260
|
-
"type": "string"
|
|
2261
|
-
},
|
|
2262
|
-
"storyType": {
|
|
2263
|
-
"const": "headerFooterSlot",
|
|
2264
|
-
"type": "string"
|
|
2265
|
-
},
|
|
2266
|
-
"section": {
|
|
2267
|
-
"type": "object",
|
|
2268
|
-
"properties": {
|
|
2269
|
-
"kind": {
|
|
2270
|
-
"const": "section",
|
|
2271
|
-
"type": "string"
|
|
2272
|
-
},
|
|
2273
|
-
"sectionId": {
|
|
2274
|
-
"type": "string"
|
|
2275
|
-
}
|
|
2276
|
-
},
|
|
2277
|
-
"required": [
|
|
2278
|
-
"kind",
|
|
2279
|
-
"sectionId"
|
|
2280
|
-
]
|
|
2281
|
-
},
|
|
2282
|
-
"headerFooterKind": {
|
|
2283
|
-
"enum": [
|
|
2284
|
-
"header",
|
|
2285
|
-
"footer"
|
|
2286
|
-
]
|
|
2287
|
-
},
|
|
2288
|
-
"variant": {
|
|
2289
|
-
"enum": [
|
|
2290
|
-
"default",
|
|
2291
|
-
"first",
|
|
2292
|
-
"even"
|
|
2293
|
-
]
|
|
2294
|
-
},
|
|
2295
|
-
"resolution": {
|
|
2296
|
-
"enum": [
|
|
2297
|
-
"effective",
|
|
2298
|
-
"explicit"
|
|
2299
|
-
]
|
|
2300
|
-
},
|
|
2301
|
-
"onWrite": {
|
|
2302
|
-
"enum": [
|
|
2303
|
-
"materializeIfInherited",
|
|
2304
|
-
"editResolvedPart",
|
|
2305
|
-
"error"
|
|
2306
|
-
]
|
|
2307
|
-
}
|
|
2308
|
-
},
|
|
2309
|
-
"required": [
|
|
2310
|
-
"kind",
|
|
2311
|
-
"storyType",
|
|
2312
|
-
"section",
|
|
2313
|
-
"headerFooterKind",
|
|
2314
|
-
"variant"
|
|
2315
|
-
]
|
|
2316
|
-
},
|
|
2317
|
-
{
|
|
2318
|
-
"type": "object",
|
|
2319
|
-
"properties": {
|
|
2320
|
-
"kind": {
|
|
2321
|
-
"const": "story",
|
|
2322
|
-
"type": "string"
|
|
2323
|
-
},
|
|
2324
|
-
"storyType": {
|
|
2325
|
-
"const": "headerFooterPart",
|
|
2326
|
-
"type": "string"
|
|
2327
|
-
},
|
|
2328
|
-
"refId": {
|
|
2329
|
-
"type": "string"
|
|
2330
|
-
}
|
|
2331
|
-
},
|
|
2332
|
-
"required": [
|
|
2333
|
-
"kind",
|
|
2334
|
-
"storyType",
|
|
2335
|
-
"refId"
|
|
2336
|
-
]
|
|
2337
|
-
},
|
|
2338
|
-
{
|
|
2339
|
-
"type": "object",
|
|
2340
|
-
"properties": {
|
|
2341
|
-
"kind": {
|
|
2342
|
-
"const": "story",
|
|
2343
|
-
"type": "string"
|
|
2344
|
-
},
|
|
2345
|
-
"storyType": {
|
|
2346
|
-
"const": "footnote",
|
|
2347
|
-
"type": "string"
|
|
2348
|
-
},
|
|
2349
|
-
"noteId": {
|
|
2350
|
-
"type": "string"
|
|
2351
|
-
}
|
|
2352
|
-
},
|
|
2353
|
-
"required": [
|
|
2354
|
-
"kind",
|
|
2355
|
-
"storyType",
|
|
2356
|
-
"noteId"
|
|
2357
|
-
]
|
|
2358
|
-
},
|
|
2359
|
-
{
|
|
2360
|
-
"type": "object",
|
|
2361
|
-
"properties": {
|
|
2362
|
-
"kind": {
|
|
2363
|
-
"const": "story",
|
|
2364
|
-
"type": "string"
|
|
2365
|
-
},
|
|
2366
|
-
"storyType": {
|
|
2367
|
-
"const": "endnote",
|
|
2368
|
-
"type": "string"
|
|
2369
|
-
},
|
|
2370
|
-
"noteId": {
|
|
2371
|
-
"type": "string"
|
|
2372
|
-
}
|
|
2373
|
-
},
|
|
2374
|
-
"required": [
|
|
2375
|
-
"kind",
|
|
2376
|
-
"storyType",
|
|
2377
|
-
"noteId"
|
|
2378
|
-
]
|
|
2379
|
-
}
|
|
2380
|
-
]
|
|
2381
|
-
},
|
|
2382
1594
|
"select": {
|
|
2383
1595
|
"oneOf": [
|
|
2384
1596
|
{
|
|
@@ -2549,163 +1761,9 @@
|
|
|
2549
1761
|
],
|
|
2550
1762
|
"description": "The action to perform. One of: apply, preview."
|
|
2551
1763
|
},
|
|
2552
|
-
"doc": {
|
|
2553
|
-
"type": "string",
|
|
2554
|
-
"description": "Document path. Optional when a session is already open."
|
|
2555
|
-
},
|
|
2556
|
-
"sessionId": {
|
|
2557
|
-
"type": "string",
|
|
2558
|
-
"description": "Session ID for multi-session workflows. Optional when only one session is open."
|
|
2559
|
-
},
|
|
2560
|
-
"in": {
|
|
2561
|
-
"oneOf": [
|
|
2562
|
-
{
|
|
2563
|
-
"type": "object",
|
|
2564
|
-
"properties": {
|
|
2565
|
-
"kind": {
|
|
2566
|
-
"const": "story",
|
|
2567
|
-
"type": "string"
|
|
2568
|
-
},
|
|
2569
|
-
"storyType": {
|
|
2570
|
-
"const": "body",
|
|
2571
|
-
"type": "string"
|
|
2572
|
-
}
|
|
2573
|
-
},
|
|
2574
|
-
"required": [
|
|
2575
|
-
"kind",
|
|
2576
|
-
"storyType"
|
|
2577
|
-
]
|
|
2578
|
-
},
|
|
2579
|
-
{
|
|
2580
|
-
"type": "object",
|
|
2581
|
-
"properties": {
|
|
2582
|
-
"kind": {
|
|
2583
|
-
"const": "story",
|
|
2584
|
-
"type": "string"
|
|
2585
|
-
},
|
|
2586
|
-
"storyType": {
|
|
2587
|
-
"const": "headerFooterSlot",
|
|
2588
|
-
"type": "string"
|
|
2589
|
-
},
|
|
2590
|
-
"section": {
|
|
2591
|
-
"type": "object",
|
|
2592
|
-
"properties": {
|
|
2593
|
-
"kind": {
|
|
2594
|
-
"const": "section",
|
|
2595
|
-
"type": "string"
|
|
2596
|
-
},
|
|
2597
|
-
"sectionId": {
|
|
2598
|
-
"type": "string"
|
|
2599
|
-
}
|
|
2600
|
-
},
|
|
2601
|
-
"required": [
|
|
2602
|
-
"kind",
|
|
2603
|
-
"sectionId"
|
|
2604
|
-
]
|
|
2605
|
-
},
|
|
2606
|
-
"headerFooterKind": {
|
|
2607
|
-
"enum": [
|
|
2608
|
-
"header",
|
|
2609
|
-
"footer"
|
|
2610
|
-
]
|
|
2611
|
-
},
|
|
2612
|
-
"variant": {
|
|
2613
|
-
"enum": [
|
|
2614
|
-
"default",
|
|
2615
|
-
"first",
|
|
2616
|
-
"even"
|
|
2617
|
-
]
|
|
2618
|
-
},
|
|
2619
|
-
"resolution": {
|
|
2620
|
-
"enum": [
|
|
2621
|
-
"effective",
|
|
2622
|
-
"explicit"
|
|
2623
|
-
]
|
|
2624
|
-
},
|
|
2625
|
-
"onWrite": {
|
|
2626
|
-
"enum": [
|
|
2627
|
-
"materializeIfInherited",
|
|
2628
|
-
"editResolvedPart",
|
|
2629
|
-
"error"
|
|
2630
|
-
]
|
|
2631
|
-
}
|
|
2632
|
-
},
|
|
2633
|
-
"required": [
|
|
2634
|
-
"kind",
|
|
2635
|
-
"storyType",
|
|
2636
|
-
"section",
|
|
2637
|
-
"headerFooterKind",
|
|
2638
|
-
"variant"
|
|
2639
|
-
]
|
|
2640
|
-
},
|
|
2641
|
-
{
|
|
2642
|
-
"type": "object",
|
|
2643
|
-
"properties": {
|
|
2644
|
-
"kind": {
|
|
2645
|
-
"const": "story",
|
|
2646
|
-
"type": "string"
|
|
2647
|
-
},
|
|
2648
|
-
"storyType": {
|
|
2649
|
-
"const": "headerFooterPart",
|
|
2650
|
-
"type": "string"
|
|
2651
|
-
},
|
|
2652
|
-
"refId": {
|
|
2653
|
-
"type": "string"
|
|
2654
|
-
}
|
|
2655
|
-
},
|
|
2656
|
-
"required": [
|
|
2657
|
-
"kind",
|
|
2658
|
-
"storyType",
|
|
2659
|
-
"refId"
|
|
2660
|
-
]
|
|
2661
|
-
},
|
|
2662
|
-
{
|
|
2663
|
-
"type": "object",
|
|
2664
|
-
"properties": {
|
|
2665
|
-
"kind": {
|
|
2666
|
-
"const": "story",
|
|
2667
|
-
"type": "string"
|
|
2668
|
-
},
|
|
2669
|
-
"storyType": {
|
|
2670
|
-
"const": "footnote",
|
|
2671
|
-
"type": "string"
|
|
2672
|
-
},
|
|
2673
|
-
"noteId": {
|
|
2674
|
-
"type": "string"
|
|
2675
|
-
}
|
|
2676
|
-
},
|
|
2677
|
-
"required": [
|
|
2678
|
-
"kind",
|
|
2679
|
-
"storyType",
|
|
2680
|
-
"noteId"
|
|
2681
|
-
]
|
|
2682
|
-
},
|
|
2683
|
-
{
|
|
2684
|
-
"type": "object",
|
|
2685
|
-
"properties": {
|
|
2686
|
-
"kind": {
|
|
2687
|
-
"const": "story",
|
|
2688
|
-
"type": "string"
|
|
2689
|
-
},
|
|
2690
|
-
"storyType": {
|
|
2691
|
-
"const": "endnote",
|
|
2692
|
-
"type": "string"
|
|
2693
|
-
},
|
|
2694
|
-
"noteId": {
|
|
2695
|
-
"type": "string"
|
|
2696
|
-
}
|
|
2697
|
-
},
|
|
2698
|
-
"required": [
|
|
2699
|
-
"kind",
|
|
2700
|
-
"storyType",
|
|
2701
|
-
"noteId"
|
|
2702
|
-
]
|
|
2703
|
-
}
|
|
2704
|
-
]
|
|
2705
|
-
},
|
|
2706
1764
|
"expectedRevision": {
|
|
2707
1765
|
"type": "string",
|
|
2708
|
-
"description": "Document revision for optimistic concurrency. Mutation fails if document was modified since this revision."
|
|
1766
|
+
"description": "Document revision for optimistic concurrency. Mutation fails if document was modified since this revision. Only for action 'preview'. Omit for other actions."
|
|
2709
1767
|
},
|
|
2710
1768
|
"atomic": {
|
|
2711
1769
|
"type": "boolean",
|
|
@@ -4628,7 +3686,7 @@
|
|
|
4628
3686
|
},
|
|
4629
3687
|
"force": {
|
|
4630
3688
|
"type": "boolean",
|
|
4631
|
-
"description": "Bypass confirmation checks."
|
|
3689
|
+
"description": "Bypass confirmation checks. Only for action 'apply'. Omit for other actions."
|
|
4632
3690
|
}
|
|
4633
3691
|
},
|
|
4634
3692
|
"required": [
|