@celigo/api-specs 0.2.84 → 0.2.86
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/dist/export.yml +11 -7
- package/dist/filestorage.yml +81 -38
- package/dist/import.yml +11 -6
- package/dist/tool.yml +291 -41
- package/package.json +1 -1
- package/schemas.json +3 -1
package/dist/export.yml
CHANGED
|
@@ -281,13 +281,12 @@ paths:
|
|
|
281
281
|
summary: Patch an export
|
|
282
282
|
description: |-
|
|
283
283
|
Partially updates an export using a JSON Patch document (RFC 6902).
|
|
284
|
-
Only the
|
|
285
|
-
whitelisted paths:
|
|
284
|
+
Only the following whitelisted paths are accepted:
|
|
286
285
|
|
|
287
|
-
| Path | Description |
|
|
288
|
-
|
|
289
|
-
| `/debugUntil` |
|
|
290
|
-
| `/assistantMetadata` | Assistant metadata object |
|
|
286
|
+
| Path | Operations | Description |
|
|
287
|
+
|------|------------|-------------|
|
|
288
|
+
| `/debugUntil` | `replace`, `add`, `remove` | Step debug-capture expiry (ISO-8601, at most 3600 seconds from now — a later value is rejected with 422 `update_not_allowed`); `remove` stops capture and succeeds even when the field is absent |
|
|
289
|
+
| `/assistantMetadata` | `replace` | Assistant metadata object |
|
|
291
290
|
|
|
292
291
|
All other paths are rejected with `422`.
|
|
293
292
|
operationId: patchExport
|
|
@@ -16686,7 +16685,12 @@ components:
|
|
|
16686
16685
|
type: string
|
|
16687
16686
|
format: date-time
|
|
16688
16687
|
readOnly: true
|
|
16689
|
-
description:
|
|
16688
|
+
description: |-
|
|
16689
|
+
Turns on step debug capture until this time: while it lies in the future, every
|
|
16690
|
+
request this export sends is recorded in the step's debug log
|
|
16691
|
+
(`GET /v1/{flows|apis|tools}/{containerId}/{_id}/requests`). Read-only on PUT —
|
|
16692
|
+
written only by `PATCH /v1/exports/{_id}` on `/debugUntil`, at most 3600 seconds
|
|
16693
|
+
ahead (`422` `update_not_allowed` beyond that); `remove` stops capture.
|
|
16690
16694
|
Request:
|
|
16691
16695
|
type: object
|
|
16692
16696
|
description: |-
|
package/dist/filestorage.yml
CHANGED
|
@@ -1658,6 +1658,11 @@ paths:
|
|
|
1658
1658
|
summary: Move to the account root
|
|
1659
1659
|
value:
|
|
1660
1660
|
_parentId: null
|
|
1661
|
+
renameOnMove:
|
|
1662
|
+
summary: Move into a folder and rename to avoid a collision
|
|
1663
|
+
value:
|
|
1664
|
+
_parentId: 684c3b1f2d4e6g002b0h9c34
|
|
1665
|
+
name: inv-001 (1).pdf
|
|
1661
1666
|
responses:
|
|
1662
1667
|
'200':
|
|
1663
1668
|
description: |-
|
|
@@ -1695,6 +1700,23 @@ paths:
|
|
|
1695
1700
|
x-celigo-refModel: storageitems
|
|
1696
1701
|
examples:
|
|
1697
1702
|
- - 684c3b1f2d4e6g002b0h9c34
|
|
1703
|
+
_integrationId:
|
|
1704
|
+
type:
|
|
1705
|
+
- string
|
|
1706
|
+
- 'null'
|
|
1707
|
+
format: objectId
|
|
1708
|
+
x-celigo-refModel: integrations
|
|
1709
|
+
description: |-
|
|
1710
|
+
The item's integration after the move — the destination's
|
|
1711
|
+
integration when it landed inside an integration's system
|
|
1712
|
+
folder tree, null when it landed outside one.
|
|
1713
|
+
examples:
|
|
1714
|
+
- 6ab1e7ab38d7733b4594d0d2
|
|
1715
|
+
name:
|
|
1716
|
+
type: string
|
|
1717
|
+
description: Name of the moved item.
|
|
1718
|
+
examples:
|
|
1719
|
+
- inv-001.pdf
|
|
1698
1720
|
examples:
|
|
1699
1721
|
default:
|
|
1700
1722
|
value:
|
|
@@ -1702,6 +1724,8 @@ paths:
|
|
|
1702
1724
|
_parentId: 684c3b1f2d4e6g002b0h9c34
|
|
1703
1725
|
__ancestorIds:
|
|
1704
1726
|
- 684c3b1f2d4e6g002b0h9c34
|
|
1727
|
+
_integrationId: null
|
|
1728
|
+
name: inv-001.pdf
|
|
1705
1729
|
'400':
|
|
1706
1730
|
$ref: '#/components/responses/400-bad-request'
|
|
1707
1731
|
'401':
|
|
@@ -2150,9 +2174,9 @@ paths:
|
|
|
2150
2174
|
x-internal: false
|
|
2151
2175
|
summary: Get storage usage by environment
|
|
2152
2176
|
description: |-
|
|
2153
|
-
Returns the
|
|
2154
|
-
|
|
2155
|
-
account's shared quota.
|
|
2177
|
+
Returns storage usage per environment, with the account-wide total and
|
|
2178
|
+
the quota figures `GET /v1/storage/usage` reports. Use it to see which
|
|
2179
|
+
environment is consuming the account's shared quota.
|
|
2156
2180
|
operationId: getStorageUsageByEnvironment
|
|
2157
2181
|
tags:
|
|
2158
2182
|
- File Storage
|
|
@@ -2177,18 +2201,18 @@ paths:
|
|
|
2177
2201
|
default:
|
|
2178
2202
|
value:
|
|
2179
2203
|
environments:
|
|
2180
|
-
-
|
|
2181
|
-
|
|
2204
|
+
- environment:
|
|
2205
|
+
_id: 60a1b2c3d4e5f6001a2b3c4d
|
|
2206
|
+
name: Production
|
|
2182
2207
|
activeUsage: 429496729
|
|
2183
2208
|
recycleBinUsage: 52428800
|
|
2184
2209
|
totalUsage: 481925529
|
|
2185
|
-
-
|
|
2186
|
-
|
|
2210
|
+
- environment:
|
|
2211
|
+
_id: 60a1b2c3d4e5f6001a2b3c4e
|
|
2212
|
+
name: Sandbox
|
|
2187
2213
|
activeUsage: 107374182
|
|
2188
2214
|
recycleBinUsage: 52428800
|
|
2189
2215
|
totalUsage: 159802982
|
|
2190
|
-
activeUsage: 536870912
|
|
2191
|
-
recycleBinUsage: 104857600
|
|
2192
2216
|
totalUsage: 641728512
|
|
2193
2217
|
maxAllowedUsage: 1073741824
|
|
2194
2218
|
isOverage: false
|
|
@@ -2831,6 +2855,19 @@ components:
|
|
|
2831
2855
|
type: string
|
|
2832
2856
|
format: objectId
|
|
2833
2857
|
x-celigo-refModel: storageitems
|
|
2858
|
+
_integrationId:
|
|
2859
|
+
type:
|
|
2860
|
+
- string
|
|
2861
|
+
- 'null'
|
|
2862
|
+
format: objectId
|
|
2863
|
+
x-celigo-refModel: integrations
|
|
2864
|
+
description: |-
|
|
2865
|
+
The item's integration after the move — the destination's
|
|
2866
|
+
integration when it landed inside an integration's system folder
|
|
2867
|
+
tree, null when it landed outside one. Present on success.
|
|
2868
|
+
name:
|
|
2869
|
+
type: string
|
|
2870
|
+
description: Name of the moved item (the new name when `name` was sent). Present on success.
|
|
2834
2871
|
type:
|
|
2835
2872
|
type: string
|
|
2836
2873
|
enum:
|
|
@@ -2970,6 +3007,15 @@ components:
|
|
|
2970
3007
|
the item itself or one of its descendants.
|
|
2971
3008
|
examples:
|
|
2972
3009
|
- 684c3b1f2d4e6g002b0h9c34
|
|
3010
|
+
name:
|
|
3011
|
+
type: string
|
|
3012
|
+
maxLength: 256
|
|
3013
|
+
description: |-
|
|
3014
|
+
New name applied to the item in the same write as the re-parent, so
|
|
3015
|
+
a name already taken in the destination can be resolved without a
|
|
3016
|
+
second call. Omit to keep the current name.
|
|
3017
|
+
examples:
|
|
3018
|
+
- inv-001 (1).pdf
|
|
2973
3019
|
CopyRequest:
|
|
2974
3020
|
type: object
|
|
2975
3021
|
description: Request body for copying a file.
|
|
@@ -3192,22 +3238,31 @@ components:
|
|
|
3192
3238
|
type: object
|
|
3193
3239
|
description: Storage usage for a single environment.
|
|
3194
3240
|
required:
|
|
3195
|
-
-
|
|
3241
|
+
- environment
|
|
3196
3242
|
- activeUsage
|
|
3197
3243
|
- recycleBinUsage
|
|
3198
3244
|
- totalUsage
|
|
3199
3245
|
properties:
|
|
3200
|
-
|
|
3201
|
-
type:
|
|
3202
|
-
|
|
3203
|
-
|
|
3204
|
-
|
|
3205
|
-
-
|
|
3206
|
-
|
|
3207
|
-
|
|
3208
|
-
|
|
3209
|
-
|
|
3210
|
-
|
|
3246
|
+
environment:
|
|
3247
|
+
type: object
|
|
3248
|
+
description: Environment the usage belongs to.
|
|
3249
|
+
required:
|
|
3250
|
+
- _id
|
|
3251
|
+
- name
|
|
3252
|
+
properties:
|
|
3253
|
+
_id:
|
|
3254
|
+
type: string
|
|
3255
|
+
format: objectId
|
|
3256
|
+
x-celigo-refModel: environments
|
|
3257
|
+
description: Environment id, as returned by `GET /v1/environments`.
|
|
3258
|
+
examples:
|
|
3259
|
+
- 60a1b2c3d4e5f6001a2b3c4d
|
|
3260
|
+
name:
|
|
3261
|
+
type: string
|
|
3262
|
+
description: Environment display name.
|
|
3263
|
+
examples:
|
|
3264
|
+
- Production
|
|
3265
|
+
- Sandbox
|
|
3211
3266
|
activeUsage:
|
|
3212
3267
|
type: integer
|
|
3213
3268
|
format: int64
|
|
@@ -3229,12 +3284,12 @@ components:
|
|
|
3229
3284
|
UsageEnvironments:
|
|
3230
3285
|
type: object
|
|
3231
3286
|
description: |-
|
|
3232
|
-
Per-environment usage breakdown alongside the
|
|
3233
|
-
returned by `GET /v1/storage/usage`.
|
|
3287
|
+
Per-environment usage breakdown alongside the account-wide quota
|
|
3288
|
+
figures returned by `GET /v1/storage/usage`. The active / recycle-bin
|
|
3289
|
+
split is reported per environment; the account-wide total is the sum
|
|
3290
|
+
of the rows.
|
|
3234
3291
|
required:
|
|
3235
3292
|
- environments
|
|
3236
|
-
- activeUsage
|
|
3237
|
-
- recycleBinUsage
|
|
3238
3293
|
- totalUsage
|
|
3239
3294
|
- maxAllowedUsage
|
|
3240
3295
|
- isOverage
|
|
@@ -3246,22 +3301,10 @@ components:
|
|
|
3246
3301
|
description: One entry per environment in the account.
|
|
3247
3302
|
items:
|
|
3248
3303
|
$ref: '#/components/schemas/EnvironmentUsage'
|
|
3249
|
-
activeUsage:
|
|
3250
|
-
type: integer
|
|
3251
|
-
format: int64
|
|
3252
|
-
description: Account-wide bytes consumed by active and pending files.
|
|
3253
|
-
examples:
|
|
3254
|
-
- 536870912
|
|
3255
|
-
recycleBinUsage:
|
|
3256
|
-
type: integer
|
|
3257
|
-
format: int64
|
|
3258
|
-
description: Account-wide bytes consumed by soft-deleted files.
|
|
3259
|
-
examples:
|
|
3260
|
-
- 104857600
|
|
3261
3304
|
totalUsage:
|
|
3262
3305
|
type: integer
|
|
3263
3306
|
format: int64
|
|
3264
|
-
description: Account-wide
|
|
3307
|
+
description: Account-wide bytes consumed by active, pending and soft-deleted files across every environment.
|
|
3265
3308
|
examples:
|
|
3266
3309
|
- 641728512
|
|
3267
3310
|
systemUsage:
|
package/dist/import.yml
CHANGED
|
@@ -294,12 +294,11 @@ paths:
|
|
|
294
294
|
summary: Patch an import
|
|
295
295
|
description: |-
|
|
296
296
|
Partially updates an import using a JSON Patch document (RFC 6902).
|
|
297
|
-
Only the
|
|
298
|
-
whitelisted path:
|
|
297
|
+
Only the following whitelisted path is accepted:
|
|
299
298
|
|
|
300
|
-
| Path | Description |
|
|
301
|
-
|
|
302
|
-
| `/debugUntil` |
|
|
299
|
+
| Path | Operations | Description |
|
|
300
|
+
|------|------------|-------------|
|
|
301
|
+
| `/debugUntil` | `replace`, `add`, `remove` | Step debug-capture expiry (ISO-8601, at most 3600 seconds from now — a later value is rejected with 422 `update_not_allowed`); `remove` stops capture and succeeds even when the field is absent |
|
|
303
302
|
|
|
304
303
|
All other paths are rejected with `422`.
|
|
305
304
|
operationId: patchImport
|
|
@@ -16745,7 +16744,13 @@ components:
|
|
|
16745
16744
|
type: string
|
|
16746
16745
|
format: date-time
|
|
16747
16746
|
readOnly: true
|
|
16748
|
-
description:
|
|
16747
|
+
description: |-
|
|
16748
|
+
Turns on step debug capture until this time: while it lies in the future, every
|
|
16749
|
+
request this import sends — or, for a `ToolImport`, every record passing through
|
|
16750
|
+
it with the tool's output — is recorded in the step's debug log
|
|
16751
|
+
(`GET /v1/{flows|apis|tools}/{containerId}/{_id}/requests`). Read-only on PUT —
|
|
16752
|
+
written only by `PATCH /v1/imports/{_id}` on `/debugUntil`, at most 3600 seconds
|
|
16753
|
+
ahead (`422` `update_not_allowed` beyond that); `remove` stops capture.
|
|
16749
16754
|
Request:
|
|
16750
16755
|
type: object
|
|
16751
16756
|
description: |-
|
package/dist/tool.yml
CHANGED
|
@@ -402,8 +402,14 @@ paths:
|
|
|
402
402
|
| `/name` | Tool display name |
|
|
403
403
|
| `/description` | Tool description |
|
|
404
404
|
| `/aiDescription` | AI-generated description object |
|
|
405
|
+
| `/input/debugUntil` | Debug-capture expiry for the Tool Input stage (ISO-8601, at most 3600 seconds from now) |
|
|
406
|
+
| `/output/debugUntil` | Debug-capture expiry for the Tool Output stage (ISO-8601, at most 3600 seconds from now) |
|
|
405
407
|
|
|
406
|
-
All other paths are rejected with 422 (`not a whitelisted property`).
|
|
408
|
+
All other paths are rejected with 422 (`not a whitelisted property`). A
|
|
409
|
+
`debugUntil` more than 3600 seconds ahead is rejected with 422
|
|
410
|
+
`update_not_allowed` and nothing is saved; `remove` on an absent
|
|
411
|
+
`debugUntil` succeeds (204). Changing a `debugUntil` needs the Tool
|
|
412
|
+
update permission on the Tool's integration, like every other path.
|
|
407
413
|
|
|
408
414
|
PATCH is the intended way to update these fields without accidentally
|
|
409
415
|
resetting other tool configuration via `PUT`.
|
|
@@ -2624,9 +2630,24 @@ paths:
|
|
|
2624
2630
|
description: |-
|
|
2625
2631
|
Lists the debug request records captured for a specific step of a tool.
|
|
2626
2632
|
These are the raw request/response payloads the step processed, retained
|
|
2627
|
-
for troubleshooting while debug capture is active for the step
|
|
2628
|
-
`
|
|
2629
|
-
|
|
2633
|
+
for troubleshooting while debug capture is active for the step — a future
|
|
2634
|
+
`debugUntil` on the step's export or import document, or `input.debugUntil`
|
|
2635
|
+
/ `output.debugUntil` on the tool for the Tool Input and Tool Output
|
|
2636
|
+
stages. Capture runs in every execution context (a standalone invoke at
|
|
2637
|
+
any `x-log-mode`, an AI agent or MCP caller, a flow or API that calls the
|
|
2638
|
+
tool, a parent tool); test runs write nothing here. Use the `key` of an
|
|
2639
|
+
entry with `GET /v1/tools/{_id}/{_stepId}/requests/{key}` to fetch the
|
|
2640
|
+
full detail of a single captured request.
|
|
2641
|
+
|
|
2642
|
+
HTTP and NetSuite steps record one entry per request they send. The
|
|
2643
|
+
`tool_input` stage records one entry per incoming record (`200` when the
|
|
2644
|
+
record passes the input schema, `422` with the validation errors when it
|
|
2645
|
+
does not); the `tool_output` stage records one entry per output
|
|
2646
|
+
validation. Routers, filters and scripts never record.
|
|
2647
|
+
|
|
2648
|
+
An account owner or administrator lists every entry. A shared user sees
|
|
2649
|
+
only entries from runs invoked under integrations they can access
|
|
2650
|
+
(standalone invokes are recorded under the tool's own integration).
|
|
2630
2651
|
|
|
2631
2652
|
When more records match than fit in one page, `nextPageURL` returns the
|
|
2632
2653
|
relative URL for the next page.
|
|
@@ -2656,15 +2677,21 @@ paths:
|
|
|
2656
2677
|
required: true
|
|
2657
2678
|
description: |-
|
|
2658
2679
|
The step whose captured logs to list: the ObjectId of an export or
|
|
2659
|
-
import step defined directly in this tool's routers
|
|
2660
|
-
|
|
2661
|
-
|
|
2662
|
-
|
|
2680
|
+
import step defined directly in this tool's routers, or one of the
|
|
2681
|
+
two virtual stage ids `tool_input` (the record entering the tool,
|
|
2682
|
+
validated against the input schema) and `tool_output` (the
|
|
2683
|
+
post-mapped record, validated against the output schema). Steps
|
|
2684
|
+
nested inside a child tool are addressed on that child tool's id;
|
|
2685
|
+
an ObjectId that is not a direct step of this tool returns `404`
|
|
2686
|
+
`invalid_ref`. Any other value — including reserved path segments
|
|
2687
|
+
such as `invocations`, `invoke`, and `test` — returns `400`
|
|
2688
|
+
`invalid_ref`.
|
|
2663
2689
|
schema:
|
|
2664
2690
|
type: string
|
|
2665
|
-
format: objectId
|
|
2666
2691
|
examples:
|
|
2667
2692
|
- 67ee026136f4d1eeb529ad63
|
|
2693
|
+
- tool_input
|
|
2694
|
+
- tool_output
|
|
2668
2695
|
- name: time_gt
|
|
2669
2696
|
in: query
|
|
2670
2697
|
required: false
|
|
@@ -2771,7 +2798,11 @@ paths:
|
|
|
2771
2798
|
description: Response status code of the captured request.
|
|
2772
2799
|
stage:
|
|
2773
2800
|
type: string
|
|
2774
|
-
description:
|
|
2801
|
+
description: |-
|
|
2802
|
+
Processing stage the record was captured in, such as
|
|
2803
|
+
`lookup` for a lookup step's request. Present on
|
|
2804
|
+
records written by HTTP and NetSuite steps; absent on
|
|
2805
|
+
`tool_input` and `tool_output` records.
|
|
2775
2806
|
additionalProperties: true
|
|
2776
2807
|
nextPageURL:
|
|
2777
2808
|
type: string
|
|
@@ -2789,16 +2820,60 @@ paths:
|
|
|
2789
2820
|
summary: Captured debug requests for a tool step
|
|
2790
2821
|
value:
|
|
2791
2822
|
requests:
|
|
2792
|
-
- key: 5481201053696-a10af1ade8fe477a847771c1e3716e36-200-
|
|
2823
|
+
- key: 5481201053696-a10af1ade8fe477a847771c1e3716e36-200-GET-lookup-60a2c4e6f321d800129a1a3c
|
|
2793
2824
|
time: 1776917346304
|
|
2825
|
+
method: GET
|
|
2826
|
+
statusCode: '200'
|
|
2827
|
+
stage: lookup
|
|
2828
|
+
tool_input:
|
|
2829
|
+
summary: Captured Tool Input records — one passed, one failed the input schema
|
|
2830
|
+
value:
|
|
2831
|
+
requests:
|
|
2832
|
+
- key: 5466610903705-847304f37d2041a79b9e657ea9a45d68-200-POST--60a2c4e6f321d800129a1a3c
|
|
2833
|
+
time: 1791507496295
|
|
2794
2834
|
method: POST
|
|
2795
2835
|
statusCode: '200'
|
|
2836
|
+
- key: 5466610902616-0d4aa1266fcb4ae4be5a7f316ff5e01c-422-POST--60a2c4e6f321d800129a1a3c
|
|
2837
|
+
time: 1791507497384
|
|
2838
|
+
method: POST
|
|
2839
|
+
statusCode: '422'
|
|
2840
|
+
'400':
|
|
2841
|
+
description: |-
|
|
2842
|
+
`_stepId` is neither an ObjectId nor `tool_input` / `tool_output`.
|
|
2843
|
+
Error code: `invalid_ref`.
|
|
2844
|
+
content:
|
|
2845
|
+
application/json:
|
|
2846
|
+
schema:
|
|
2847
|
+
$ref: '#/components/schemas/Error'
|
|
2848
|
+
examples:
|
|
2849
|
+
unknown_virtual_id:
|
|
2850
|
+
value:
|
|
2851
|
+
errors:
|
|
2852
|
+
- code: invalid_ref
|
|
2853
|
+
message: Please provide a valid _expOrImpId.
|
|
2796
2854
|
'401':
|
|
2797
2855
|
$ref: '#/components/responses/401-unauthorized'
|
|
2798
2856
|
'403':
|
|
2799
2857
|
$ref: '#/components/responses/403-forbidden'
|
|
2800
2858
|
'404':
|
|
2801
|
-
|
|
2859
|
+
description: |-
|
|
2860
|
+
The tool does not exist, or `_stepId` is an ObjectId that is not a
|
|
2861
|
+
step defined directly in this tool. Error code: `invalid_ref`.
|
|
2862
|
+
content:
|
|
2863
|
+
application/json:
|
|
2864
|
+
schema:
|
|
2865
|
+
$ref: '#/components/schemas/Error'
|
|
2866
|
+
examples:
|
|
2867
|
+
tool_not_found:
|
|
2868
|
+
value:
|
|
2869
|
+
errors:
|
|
2870
|
+
- code: invalid_ref
|
|
2871
|
+
message: Tool not found.
|
|
2872
|
+
step_not_in_tool:
|
|
2873
|
+
value:
|
|
2874
|
+
errors:
|
|
2875
|
+
- code: invalid_ref
|
|
2876
|
+
message: Export/Import not found.
|
|
2802
2877
|
'422':
|
|
2803
2878
|
description: 'Invalid time filter parameters. Error code: `invalid_or_missing_field`.'
|
|
2804
2879
|
content:
|
|
@@ -2822,12 +2897,16 @@ paths:
|
|
|
2822
2897
|
description: |-
|
|
2823
2898
|
Deletes captured debug request records for a specific step of a tool, by
|
|
2824
2899
|
their `key` values from `GET /v1/tools/{_id}/{_stepId}/requests`. Between
|
|
2825
|
-
1 and 1000 keys can be deleted per call
|
|
2900
|
+
1 and 1000 keys can be deleted per call; the deletion is synchronous and
|
|
2901
|
+
scoped to this step only.
|
|
2826
2902
|
|
|
2827
2903
|
The response lists the keys that were deleted and, separately, any keys
|
|
2828
|
-
that failed to delete along with the failure reason.
|
|
2904
|
+
that failed to delete along with the failure reason. A key that no longer
|
|
2905
|
+
exists is reported under `deleted`, not `errors`.
|
|
2829
2906
|
|
|
2830
|
-
Requires the `manage:tool:logs:deletion` permission.
|
|
2907
|
+
Requires the `manage:tool:logs:deletion` permission. A shared user's
|
|
2908
|
+
delete removes only records from runs invoked under integrations they can
|
|
2909
|
+
access.
|
|
2831
2910
|
operationId: deleteToolStepRequests
|
|
2832
2911
|
tags:
|
|
2833
2912
|
- Tools
|
|
@@ -2847,12 +2926,16 @@ paths:
|
|
|
2847
2926
|
required: true
|
|
2848
2927
|
description: |-
|
|
2849
2928
|
The step whose captured logs to delete: the ObjectId of an export or
|
|
2850
|
-
import step defined directly in this tool's routers
|
|
2929
|
+
import step defined directly in this tool's routers, or the virtual
|
|
2930
|
+
stage id `tool_input` or `tool_output`. Any other value returns
|
|
2931
|
+
`400` `invalid_ref`; an ObjectId that is not a direct step of this
|
|
2932
|
+
tool returns `404` `invalid_ref`.
|
|
2851
2933
|
schema:
|
|
2852
2934
|
type: string
|
|
2853
|
-
format: objectId
|
|
2854
2935
|
examples:
|
|
2855
2936
|
- 67ee026136f4d1eeb529ad63
|
|
2937
|
+
- tool_input
|
|
2938
|
+
- tool_output
|
|
2856
2939
|
requestBody:
|
|
2857
2940
|
required: true
|
|
2858
2941
|
content:
|
|
@@ -2919,13 +3002,43 @@ paths:
|
|
|
2919
3002
|
- 5481201048878-b21bf2bef9ff588b958882d2f4827f47-422-POST
|
|
2920
3003
|
errors: []
|
|
2921
3004
|
'400':
|
|
2922
|
-
|
|
3005
|
+
description: |-
|
|
3006
|
+
The body carries no `keys` array (error code `invalid_url`), or
|
|
3007
|
+
`_stepId` is neither an ObjectId nor `tool_input` / `tool_output`
|
|
3008
|
+
(error code `invalid_ref`).
|
|
3009
|
+
content:
|
|
3010
|
+
application/json:
|
|
3011
|
+
schema:
|
|
3012
|
+
$ref: '#/components/schemas/Error'
|
|
3013
|
+
examples:
|
|
3014
|
+
missing_keys:
|
|
3015
|
+
value:
|
|
3016
|
+
errors:
|
|
3017
|
+
- code: invalid_url
|
|
3018
|
+
message: keys is not valid.
|
|
3019
|
+
unknown_virtual_id:
|
|
3020
|
+
value:
|
|
3021
|
+
errors:
|
|
3022
|
+
- code: invalid_ref
|
|
3023
|
+
message: Please provide a valid _expOrImpId.
|
|
2923
3024
|
'401':
|
|
2924
3025
|
$ref: '#/components/responses/401-unauthorized'
|
|
2925
3026
|
'403':
|
|
2926
3027
|
$ref: '#/components/responses/403-forbidden'
|
|
2927
3028
|
'404':
|
|
2928
|
-
|
|
3029
|
+
description: |-
|
|
3030
|
+
The tool does not exist, or `_stepId` is an ObjectId that is not a
|
|
3031
|
+
step defined directly in this tool. Error code: `invalid_ref`.
|
|
3032
|
+
content:
|
|
3033
|
+
application/json:
|
|
3034
|
+
schema:
|
|
3035
|
+
$ref: '#/components/schemas/Error'
|
|
3036
|
+
examples:
|
|
3037
|
+
step_not_in_tool:
|
|
3038
|
+
value:
|
|
3039
|
+
errors:
|
|
3040
|
+
- code: invalid_ref
|
|
3041
|
+
message: Export/Import not found.
|
|
2929
3042
|
/v1/tools/{_id}/{_stepId}/requests/{key}:
|
|
2930
3043
|
get:
|
|
2931
3044
|
x-internal: false
|
|
@@ -2935,8 +3048,15 @@ paths:
|
|
|
2935
3048
|
step, identified by its `key`. Obtain the `key` from
|
|
2936
3049
|
`GET /v1/tools/{_id}/{_stepId}/requests`.
|
|
2937
3050
|
|
|
2938
|
-
|
|
2939
|
-
|
|
3051
|
+
For an HTTP or NetSuite step the record carries the adaptor HTTP
|
|
3052
|
+
request/response the step issued, with credentials masked and the
|
|
3053
|
+
bodies as strings. For the `tool_input` and `tool_output` stages (and a
|
|
3054
|
+
ToolImport step) the record is synthetic: `request.body` is the JSON
|
|
3055
|
+
record entering the stage, `response.body` is the validated JSON record
|
|
3056
|
+
(`statusCode` 200) or the validation errors (`statusCode` 422), the
|
|
3057
|
+
request carries no `url`, and `context` names the run that produced it.
|
|
3058
|
+
Synthetic bodies are stored unmasked. Every record carries the `key`,
|
|
3059
|
+
record `id`, and capture `time`.
|
|
2940
3060
|
|
|
2941
3061
|
Requires the `manage:tool:logs` permission.
|
|
2942
3062
|
operationId: getToolStepRequest
|
|
@@ -2958,15 +3078,18 @@ paths:
|
|
|
2958
3078
|
required: true
|
|
2959
3079
|
description: |-
|
|
2960
3080
|
The step the captured request belongs to: the ObjectId of an export
|
|
2961
|
-
or import step defined directly in this tool's routers
|
|
2962
|
-
|
|
2963
|
-
|
|
2964
|
-
|
|
3081
|
+
or import step defined directly in this tool's routers, or the
|
|
3082
|
+
virtual stage id `tool_input` or `tool_output`. Steps nested inside
|
|
3083
|
+
a child tool are addressed on that child tool's id; an ObjectId that
|
|
3084
|
+
is not a direct step of this tool returns `404` `invalid_ref`. Any
|
|
3085
|
+
other value — including reserved path segments such as
|
|
3086
|
+
`invocations`, `invoke`, and `test` — returns `400` `invalid_ref`.
|
|
2965
3087
|
schema:
|
|
2966
3088
|
type: string
|
|
2967
|
-
format: objectId
|
|
2968
3089
|
examples:
|
|
2969
3090
|
- 67ee026136f4d1eeb529ad63
|
|
3091
|
+
- tool_input
|
|
3092
|
+
- tool_output
|
|
2970
3093
|
- name: key
|
|
2971
3094
|
in: path
|
|
2972
3095
|
required: true
|
|
@@ -2998,51 +3121,84 @@ paths:
|
|
|
2998
3121
|
description: Epoch milliseconds when this pair was stored.
|
|
2999
3122
|
request:
|
|
3000
3123
|
type: object
|
|
3001
|
-
description:
|
|
3124
|
+
description: |-
|
|
3125
|
+
The HTTP request the step's export or import sent, or — for
|
|
3126
|
+
the `tool_input`, `tool_output` and ToolImport stages — the
|
|
3127
|
+
record entering the stage, wrapped as a `POST` with no `url`.
|
|
3002
3128
|
properties:
|
|
3003
3129
|
method:
|
|
3004
3130
|
type: string
|
|
3005
|
-
description: HTTP method (`GET`, `POST`, …).
|
|
3131
|
+
description: HTTP method (`GET`, `POST`, …); always `POST` on synthetic records.
|
|
3006
3132
|
examples:
|
|
3007
3133
|
- POST
|
|
3008
3134
|
url:
|
|
3009
3135
|
type: string
|
|
3010
|
-
description: Fully-resolved URL the request was sent to.
|
|
3136
|
+
description: Fully-resolved URL the request was sent to. Absent on synthetic records.
|
|
3011
3137
|
examples:
|
|
3012
3138
|
- https://httpbin.org/post
|
|
3013
3139
|
headers:
|
|
3014
3140
|
type: object
|
|
3015
|
-
description: Headers sent with the request; credential values are masked.
|
|
3141
|
+
description: Headers sent with the request; credential values are masked. Empty on synthetic records.
|
|
3016
3142
|
additionalProperties: true
|
|
3017
3143
|
body:
|
|
3018
|
-
type:
|
|
3019
|
-
|
|
3144
|
+
type:
|
|
3145
|
+
- string
|
|
3146
|
+
- object
|
|
3147
|
+
description: |-
|
|
3148
|
+
Request body as sent, verbatim, for an HTTP step (absent on a
|
|
3149
|
+
body-less method such as `GET`); the JSON record entering the
|
|
3150
|
+
stage on a synthetic record.
|
|
3020
3151
|
examples:
|
|
3021
3152
|
- '{"orderId":"SO-1042"}'
|
|
3022
3153
|
response:
|
|
3023
3154
|
type: object
|
|
3024
|
-
description:
|
|
3155
|
+
description: |-
|
|
3156
|
+
The HTTP response the step received, or — on synthetic
|
|
3157
|
+
records — the outcome of the stage: the validated record
|
|
3158
|
+
with `statusCode` 200, or the validation errors with 422.
|
|
3025
3159
|
properties:
|
|
3026
3160
|
statusCode:
|
|
3027
3161
|
type: integer
|
|
3028
|
-
description: HTTP status code the target system returned.
|
|
3162
|
+
description: HTTP status code the target system returned, or 200 / 422 for a synthetic record.
|
|
3029
3163
|
examples:
|
|
3030
3164
|
- 200
|
|
3031
3165
|
headers:
|
|
3032
3166
|
type: object
|
|
3033
|
-
description: Response headers as received.
|
|
3167
|
+
description: Response headers as received. Empty on synthetic records.
|
|
3034
3168
|
additionalProperties: true
|
|
3035
3169
|
body:
|
|
3036
|
-
type:
|
|
3037
|
-
|
|
3170
|
+
type:
|
|
3171
|
+
- string
|
|
3172
|
+
- object
|
|
3173
|
+
description: |-
|
|
3174
|
+
For an HTTP or NetSuite step: the response body as received, a
|
|
3175
|
+
string the caller parses per the `content-type` header. On a
|
|
3176
|
+
synthetic record: the validated JSON record as an object, or
|
|
3177
|
+
`{errors: [{code, message, …}]}` when validation failed.
|
|
3038
3178
|
examples:
|
|
3039
3179
|
- '{"ok":true}'
|
|
3180
|
+
receivedAt:
|
|
3181
|
+
type: integer
|
|
3182
|
+
format: int64
|
|
3183
|
+
description: Epoch milliseconds when the pair was captured.
|
|
3184
|
+
context:
|
|
3185
|
+
type: object
|
|
3186
|
+
description: |-
|
|
3187
|
+
The run that produced a synthetic record. Absent on records
|
|
3188
|
+
written by HTTP and NetSuite steps.
|
|
3189
|
+
properties:
|
|
3190
|
+
_rootContainerId:
|
|
3191
|
+
type: string
|
|
3192
|
+
description: Owning flow, API, or tool id of the run that produced this capture.
|
|
3193
|
+
_jobId:
|
|
3194
|
+
type: string
|
|
3195
|
+
description: Job id of the run that produced this capture.
|
|
3040
3196
|
additionalProperties: true
|
|
3041
3197
|
examples:
|
|
3042
3198
|
adaptor_http:
|
|
3043
3199
|
summary: Captured HTTP request of a lookup step
|
|
3044
3200
|
value:
|
|
3045
|
-
key: 5481201053696-a10af1ade8fe477a847771c1e3716e36-200-POST
|
|
3201
|
+
key: 5481201053696-a10af1ade8fe477a847771c1e3716e36-200-POST-lookup-60a2c4e6f321d800129a1a3c
|
|
3046
3202
|
id: a10af1ade8fe477a847771c1e3716e36
|
|
3047
3203
|
time: 1776917346304
|
|
3048
3204
|
request:
|
|
@@ -3056,12 +3212,67 @@ paths:
|
|
|
3056
3212
|
headers:
|
|
3057
3213
|
content-type: application/json
|
|
3058
3214
|
body: '{"ok":true}'
|
|
3215
|
+
receivedAt: 1776917346302
|
|
3216
|
+
tool_input_failed:
|
|
3217
|
+
summary: Synthetic Tool Input record — the record failed the input schema
|
|
3218
|
+
value:
|
|
3219
|
+
key: 5466610902616-0d4aa1266fcb4ae4be5a7f316ff5e01c-422-POST--60a2c4e6f321d800129a1a3c
|
|
3220
|
+
id: 0d4aa1266fcb4ae4be5a7f316ff5e01c
|
|
3221
|
+
time: 1791507497384
|
|
3222
|
+
request:
|
|
3223
|
+
method: POST
|
|
3224
|
+
headers: {}
|
|
3225
|
+
body: {}
|
|
3226
|
+
response:
|
|
3227
|
+
statusCode: 422
|
|
3228
|
+
headers: {}
|
|
3229
|
+
receivedAt: 1791507497384
|
|
3230
|
+
body:
|
|
3231
|
+
errors:
|
|
3232
|
+
- code: tool_input_schema_validation_failed
|
|
3233
|
+
message: 'Tool input validation failed: must have required property ''q'''
|
|
3234
|
+
source: tool_input
|
|
3235
|
+
stage: tool_input_schema_validation
|
|
3236
|
+
context:
|
|
3237
|
+
_rootContainerId: 69d462d5b9c28ea0b7f82522
|
|
3238
|
+
_jobId: 6ac83c299205d177fa25df54
|
|
3239
|
+
'400':
|
|
3240
|
+
description: |-
|
|
3241
|
+
`_stepId` is neither an ObjectId nor `tool_input` / `tool_output`.
|
|
3242
|
+
Error code: `invalid_ref`.
|
|
3243
|
+
content:
|
|
3244
|
+
application/json:
|
|
3245
|
+
schema:
|
|
3246
|
+
$ref: '#/components/schemas/Error'
|
|
3247
|
+
examples:
|
|
3248
|
+
unknown_virtual_id:
|
|
3249
|
+
value:
|
|
3250
|
+
errors:
|
|
3251
|
+
- code: invalid_ref
|
|
3252
|
+
message: Please provide a valid _expOrImpId.
|
|
3059
3253
|
'401':
|
|
3060
3254
|
$ref: '#/components/responses/401-unauthorized'
|
|
3061
3255
|
'403':
|
|
3062
3256
|
$ref: '#/components/responses/403-forbidden'
|
|
3063
3257
|
'404':
|
|
3064
|
-
|
|
3258
|
+
description: |-
|
|
3259
|
+
The tool or the step does not exist (`invalid_ref`), or no record
|
|
3260
|
+
carries this `key` (`file_not_found`).
|
|
3261
|
+
content:
|
|
3262
|
+
application/json:
|
|
3263
|
+
schema:
|
|
3264
|
+
$ref: '#/components/schemas/Error'
|
|
3265
|
+
examples:
|
|
3266
|
+
unknown_key:
|
|
3267
|
+
value:
|
|
3268
|
+
errors:
|
|
3269
|
+
- code: file_not_found
|
|
3270
|
+
message: We are unable to find the file for the given fileName.
|
|
3271
|
+
step_not_in_tool:
|
|
3272
|
+
value:
|
|
3273
|
+
errors:
|
|
3274
|
+
- code: invalid_ref
|
|
3275
|
+
message: Export/Import not found.
|
|
3065
3276
|
components:
|
|
3066
3277
|
securitySchemes:
|
|
3067
3278
|
bearerAuth:
|
|
@@ -5873,6 +6084,20 @@ components:
|
|
|
5873
6084
|
("requires at least one double stash expression"), and an unbalanced `{{record.id`
|
|
5874
6085
|
fails with 422 "Failed to compile handlebars template". An empty string clears the
|
|
5875
6086
|
field.
|
|
6087
|
+
debugUntil:
|
|
6088
|
+
type: string
|
|
6089
|
+
format: date-time
|
|
6090
|
+
description: |-
|
|
6091
|
+
Turns on debug capture for the Tool Input stage until this time: while it lies in
|
|
6092
|
+
the future, every record entering the tool is written to
|
|
6093
|
+
`GET /v1/tools/{_id}/tool_input/requests` with its input-schema outcome, in every
|
|
6094
|
+
execution context (standalone invoke, AI agent or MCP caller, flow or API). At
|
|
6095
|
+
most 3600 seconds ahead — a later value is rejected with `422` `update_not_allowed`
|
|
6096
|
+
and nothing is saved. Written by PUT or by `PATCH /v1/tools/{_id}` on
|
|
6097
|
+
`/input/debugUntil`; `remove` (or a past time) stops capture. Capture is not
|
|
6098
|
+
retroactive and does not change record retention.
|
|
6099
|
+
examples:
|
|
6100
|
+
- '2026-08-25T12:30:00.000Z'
|
|
5876
6101
|
mockInput:
|
|
5877
6102
|
type: object
|
|
5878
6103
|
description: |
|
|
@@ -6045,6 +6270,20 @@ components:
|
|
|
6045
6270
|
examples:
|
|
6046
6271
|
- postProcessOutput
|
|
6047
6272
|
- validateOutput
|
|
6273
|
+
debugUntil:
|
|
6274
|
+
type: string
|
|
6275
|
+
format: date-time
|
|
6276
|
+
description: |-
|
|
6277
|
+
Turns on debug capture for the Tool Output stage until this time: while it lies in
|
|
6278
|
+
the future, every post-mapped record is written to
|
|
6279
|
+
`GET /v1/tools/{_id}/tool_output/requests` with its output-schema outcome, in every
|
|
6280
|
+
execution context (standalone invoke, AI agent or MCP caller, flow or API). At
|
|
6281
|
+
most 3600 seconds ahead — a later value is rejected with `422` `update_not_allowed`
|
|
6282
|
+
and nothing is saved. Written by PUT or by `PATCH /v1/tools/{_id}` on
|
|
6283
|
+
`/output/debugUntil`; `remove` (or a past time) stops capture. Capture is not
|
|
6284
|
+
retroactive and does not change record retention.
|
|
6285
|
+
examples:
|
|
6286
|
+
- '2026-08-25T12:30:00.000Z'
|
|
6048
6287
|
mockInput:
|
|
6049
6288
|
type: object
|
|
6050
6289
|
description: |
|
|
@@ -24837,7 +25076,13 @@ components:
|
|
|
24837
25076
|
type: string
|
|
24838
25077
|
format: date-time
|
|
24839
25078
|
readOnly: true
|
|
24840
|
-
description:
|
|
25079
|
+
description: |-
|
|
25080
|
+
Turns on step debug capture until this time: while it lies in the future, every
|
|
25081
|
+
request this import sends — or, for a `ToolImport`, every record passing through
|
|
25082
|
+
it with the tool's output — is recorded in the step's debug log
|
|
25083
|
+
(`GET /v1/{flows|apis|tools}/{containerId}/{_id}/requests`). Read-only on PUT —
|
|
25084
|
+
written only by `PATCH /v1/imports/{_id}` on `/debugUntil`, at most 3600 seconds
|
|
25085
|
+
ahead (`422` `update_not_allowed` beyond that); `remove` stops capture.
|
|
24841
25086
|
GroupBy:
|
|
24842
25087
|
type: array
|
|
24843
25088
|
description: |
|
|
@@ -36678,7 +36923,12 @@ components:
|
|
|
36678
36923
|
type: string
|
|
36679
36924
|
format: date-time
|
|
36680
36925
|
readOnly: true
|
|
36681
|
-
description:
|
|
36926
|
+
description: |-
|
|
36927
|
+
Turns on step debug capture until this time: while it lies in the future, every
|
|
36928
|
+
request this export sends is recorded in the step's debug log
|
|
36929
|
+
(`GET /v1/{flows|apis|tools}/{containerId}/{_id}/requests`). Read-only on PUT —
|
|
36930
|
+
written only by `PATCH /v1/exports/{_id}` on `/debugUntil`, at most 3600 seconds
|
|
36931
|
+
ahead (`422` `update_not_allowed` beyond that); `remove` stops capture.
|
|
36682
36932
|
ClonePreviewResponse:
|
|
36683
36933
|
type: object
|
|
36684
36934
|
description: |
|
package/package.json
CHANGED
package/schemas.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"provenance": {
|
|
3
3
|
"repo": "celigo/integrator-api-specs",
|
|
4
|
-
"iasCommit": "
|
|
4
|
+
"iasCommit": "2d9562f",
|
|
5
5
|
"generatedAt": "2026-10-10"
|
|
6
6
|
},
|
|
7
7
|
"roots": {
|
|
@@ -8707,6 +8707,7 @@
|
|
|
8707
8707
|
"object"
|
|
8708
8708
|
],
|
|
8709
8709
|
"p": {
|
|
8710
|
+
"debugUntil": 1,
|
|
8710
8711
|
"description": 1,
|
|
8711
8712
|
"mockInput": 10,
|
|
8712
8713
|
"name": 1,
|
|
@@ -8799,6 +8800,7 @@
|
|
|
8799
8800
|
"object"
|
|
8800
8801
|
],
|
|
8801
8802
|
"p": {
|
|
8803
|
+
"debugUntil": 1,
|
|
8802
8804
|
"description": 1,
|
|
8803
8805
|
"hooks": 196,
|
|
8804
8806
|
"lookups": 733,
|