@celigo/api-specs 0.2.173 → 0.2.175
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/account.yml +15 -15
- package/dist/api.yml +13 -6
- package/dist/connection.yml +18 -6
- package/dist/enduser.yml +13 -6
- package/dist/export.yml +12 -0
- package/dist/filedefinitionrules.yml +18 -10
- package/dist/flow.yml +20 -2
- package/dist/import.yml +20 -2
- package/dist/integration.yml +20 -2
- package/dist/lookupcache.yml +31 -11
- package/dist/marketplace.yml +28 -7
- package/dist/mcp-server.yml +13 -6
- package/dist/stack.yml +1 -1
- package/dist/template.yml +66 -8
- package/dist/tool.yml +30 -8
- package/package.json +1 -1
- package/schemas.json +1 -1
package/dist/account.yml
CHANGED
|
@@ -383,13 +383,12 @@ paths:
|
|
|
383
383
|
summary: One stack available
|
|
384
384
|
value:
|
|
385
385
|
- _id: 69f536192e7966f4032f2299
|
|
386
|
-
name: Production
|
|
386
|
+
name: Production extension server
|
|
387
387
|
type: server
|
|
388
388
|
server:
|
|
389
|
-
hostURI: https://
|
|
390
|
-
systemToken: '
|
|
391
|
-
ipRanges:
|
|
392
|
-
- 10.0.0.0/8
|
|
389
|
+
hostURI: https://extensions.example.com:7020
|
|
390
|
+
systemToken: '******'
|
|
391
|
+
ipRanges: []
|
|
393
392
|
empty:
|
|
394
393
|
summary: No stacks available
|
|
395
394
|
value: []
|
|
@@ -842,7 +841,7 @@ components:
|
|
|
842
841
|
name:
|
|
843
842
|
type: string
|
|
844
843
|
examples:
|
|
845
|
-
- Production
|
|
844
|
+
- Production extension server
|
|
846
845
|
description: Display name shown in the UI when selecting a stack.
|
|
847
846
|
type:
|
|
848
847
|
type: string
|
|
@@ -850,31 +849,32 @@ components:
|
|
|
850
849
|
- server
|
|
851
850
|
- lambda
|
|
852
851
|
x-enumDescriptions:
|
|
853
|
-
server:
|
|
852
|
+
server: Your own server, which Celigo calls to run hook and wrapper code.
|
|
854
853
|
lambda: AWS Lambda function managed in your own AWS account.
|
|
855
854
|
description: Execution environment type that determines which configuration block is present.
|
|
856
855
|
server:
|
|
857
856
|
type: object
|
|
858
|
-
description: Configuration
|
|
857
|
+
description: Configuration of a server stack. Present when `type` is `server`.
|
|
859
858
|
properties:
|
|
860
859
|
systemToken:
|
|
861
860
|
type: string
|
|
862
861
|
description: |-
|
|
863
|
-
|
|
864
|
-
|
|
862
|
+
System token for authenticating with the server stack. Masked in
|
|
863
|
+
GET responses.
|
|
865
864
|
hostURI:
|
|
866
865
|
type: string
|
|
867
866
|
format: uri
|
|
868
867
|
examples:
|
|
869
|
-
- https://
|
|
868
|
+
- https://extensions.example.com:7020
|
|
870
869
|
description: |-
|
|
871
|
-
Base
|
|
872
|
-
|
|
870
|
+
Base URI of the server hosting the stack. The platform calls it to
|
|
871
|
+
run hooks and wrappers.
|
|
873
872
|
ipRanges:
|
|
874
873
|
type: array
|
|
875
874
|
description: |-
|
|
876
|
-
|
|
877
|
-
|
|
875
|
+
Deprecated and not enforced: the list is stored and returned as
|
|
876
|
+
sent, but no Celigo service checks it. Restrict who can reach the
|
|
877
|
+
server at the server or its firewall.
|
|
878
878
|
items:
|
|
879
879
|
type: string
|
|
880
880
|
examples:
|
package/dist/api.yml
CHANGED
|
@@ -5454,11 +5454,13 @@ components:
|
|
|
5454
5454
|
after which the flag switches itself off), and concurrency climbs back toward
|
|
5455
5455
|
`targetConcurrencyLevel`. While true, `targetConcurrencyLevel` is the throughput lever: a
|
|
5456
5456
|
`concurrencyLevel` sent in a PUT is ignored, and one sent in a PATCH is stored but the
|
|
5457
|
-
recovery machinery moves it back toward the target.
|
|
5457
|
+
recovery machinery moves it back toward the target. Recovery never runs on `ftp`
|
|
5458
|
+
connections: FTP errors aren't treated as rate limits.
|
|
5458
5459
|
x-celigo-ai-guidance:
|
|
5459
5460
|
- To change throughput while this is true, write `targetConcurrencyLevel`; a `concurrencyLevel` sent in a PUT returns 200 and changes nothing.
|
|
5460
5461
|
- Turning it on copies `concurrencyLevel` into `targetConcurrencyLevel`; turning it off unsets the target and leaves `concurrencyLevel` at its current value, which may be below the old target if a recovery was in progress. A `targetConcurrencyLevel` written while this is false is unset by the save.
|
|
5461
5462
|
- These four settings (`concurrencyLevel`, `targetConcurrencyLevel`, `_borrowConcurrencyFromConnectionId`, this flag) accept a credential-free `PATCH /v1/connections/{_id}`. A PUT replaces the whole document, so send each secret back as its masked `******` value (that keeps it) or as a new value, and never drop one to keep it — an omitted password or `http.encrypted` is cleared, and a static token left out (with no `refreshMethod`) fails the PUT with 422.
|
|
5463
|
+
- On an `ftp` connection recovery never runs, and transfer threads are `ftp.multiThreadCount`; while this is true a create sets `ftp.concurrencyLevel` to `ftp.targetConcurrencyLevel`, or to 1 without one.
|
|
5462
5464
|
enableMicroBatchForOneToMany:
|
|
5463
5465
|
type: boolean
|
|
5464
5466
|
default: true
|
|
@@ -6076,6 +6078,10 @@ components:
|
|
|
6076
6078
|
FTP servers often have low connection limits — keep this value conservative.
|
|
6077
6079
|
Send no more than the account's licensed maximum, the license's `concurrency` (25 standard,
|
|
6078
6080
|
50 with an Environments license).
|
|
6081
|
+
While `autoRecoverRateLimitErrors` is true, which a create gets unless it sends `false`, a create
|
|
6082
|
+
ignores the value sent here and sets this field to `targetConcurrencyLevel`, or to 1 when no
|
|
6083
|
+
target is sent. To start higher, send `targetConcurrencyLevel` too, or create with
|
|
6084
|
+
`autoRecoverRateLimitErrors: false`.
|
|
6079
6085
|
Unlike the rest of the `ftp` object, a `PUT` that omits this field keeps the stored value instead of clearing it.
|
|
6080
6086
|
minimum: 1
|
|
6081
6087
|
maximum: 50
|
|
@@ -6085,8 +6091,9 @@ components:
|
|
|
6085
6091
|
targetConcurrencyLevel:
|
|
6086
6092
|
type: integer
|
|
6087
6093
|
description: |
|
|
6088
|
-
|
|
6089
|
-
|
|
6094
|
+
While `autoRecoverRateLimitErrors` is true, a create sets `concurrencyLevel` to this value, and a
|
|
6095
|
+
create that omits it gets 1 for both. Auto-recovery never runs on FTP connections (FTP errors
|
|
6096
|
+
aren't treated as rate limits), so nothing climbs back to it.
|
|
6090
6097
|
Kept on a `PUT` that omits it, like `concurrencyLevel`; unset by the save while
|
|
6091
6098
|
`autoRecoverRateLimitErrors` is false.
|
|
6092
6099
|
minimum: 1
|
|
@@ -6117,9 +6124,9 @@ components:
|
|
|
6117
6124
|
type: integer
|
|
6118
6125
|
readOnly: true
|
|
6119
6126
|
description: |-
|
|
6120
|
-
Server-maintained mirror of `multiThreadCount
|
|
6121
|
-
|
|
6122
|
-
recomputed on save.
|
|
6127
|
+
Server-maintained mirror of `multiThreadCount`, present while
|
|
6128
|
+
`autoRecoverRateLimitErrors` is true and `targetConcurrencyLevel` is
|
|
6129
|
+
set; recomputed on save.
|
|
6123
6130
|
if:
|
|
6124
6131
|
properties:
|
|
6125
6132
|
type:
|
package/dist/connection.yml
CHANGED
|
@@ -1034,6 +1034,10 @@ paths:
|
|
|
1034
1034
|
from cannot start borrowing (422 `connection_borrowed_by_another`). A
|
|
1035
1035
|
connection can't borrow from itself: naming its own id is rejected with 422 ("… a
|
|
1036
1036
|
connection cannot borrow concurrency from itself."), here and on `PUT`.
|
|
1037
|
+
Auto-recovery never runs on `ftp` connections (FTP errors aren't treated as rate limits),
|
|
1038
|
+
so on them the recovery machinery never moves `/ftp/concurrencyLevel` toward the target and
|
|
1039
|
+
nothing climbs back to `/ftp/targetConcurrencyLevel`; the target still persists only while
|
|
1040
|
+
`autoRecoverRateLimitErrors` is true.
|
|
1037
1041
|
Settings-only changes are recorded in the connection's audit log.
|
|
1038
1042
|
operationId: patchConnection
|
|
1039
1043
|
tags:
|
|
@@ -4301,11 +4305,13 @@ components:
|
|
|
4301
4305
|
after which the flag switches itself off), and concurrency climbs back toward
|
|
4302
4306
|
`targetConcurrencyLevel`. While true, `targetConcurrencyLevel` is the throughput lever: a
|
|
4303
4307
|
`concurrencyLevel` sent in a PUT is ignored, and one sent in a PATCH is stored but the
|
|
4304
|
-
recovery machinery moves it back toward the target.
|
|
4308
|
+
recovery machinery moves it back toward the target. Recovery never runs on `ftp`
|
|
4309
|
+
connections: FTP errors aren't treated as rate limits.
|
|
4305
4310
|
x-celigo-ai-guidance:
|
|
4306
4311
|
- To change throughput while this is true, write `targetConcurrencyLevel`; a `concurrencyLevel` sent in a PUT returns 200 and changes nothing.
|
|
4307
4312
|
- Turning it on copies `concurrencyLevel` into `targetConcurrencyLevel`; turning it off unsets the target and leaves `concurrencyLevel` at its current value, which may be below the old target if a recovery was in progress. A `targetConcurrencyLevel` written while this is false is unset by the save.
|
|
4308
4313
|
- These four settings (`concurrencyLevel`, `targetConcurrencyLevel`, `_borrowConcurrencyFromConnectionId`, this flag) accept a credential-free `PATCH /v1/connections/{_id}`. A PUT replaces the whole document, so send each secret back as its masked `******` value (that keeps it) or as a new value, and never drop one to keep it — an omitted password or `http.encrypted` is cleared, and a static token left out (with no `refreshMethod`) fails the PUT with 422.
|
|
4314
|
+
- On an `ftp` connection recovery never runs, and transfer threads are `ftp.multiThreadCount`; while this is true a create sets `ftp.concurrencyLevel` to `ftp.targetConcurrencyLevel`, or to 1 without one.
|
|
4309
4315
|
enableMicroBatchForOneToMany:
|
|
4310
4316
|
type: boolean
|
|
4311
4317
|
default: true
|
|
@@ -4923,6 +4929,10 @@ components:
|
|
|
4923
4929
|
FTP servers often have low connection limits — keep this value conservative.
|
|
4924
4930
|
Send no more than the account's licensed maximum, the license's `concurrency` (25 standard,
|
|
4925
4931
|
50 with an Environments license).
|
|
4932
|
+
While `autoRecoverRateLimitErrors` is true, which a create gets unless it sends `false`, a create
|
|
4933
|
+
ignores the value sent here and sets this field to `targetConcurrencyLevel`, or to 1 when no
|
|
4934
|
+
target is sent. To start higher, send `targetConcurrencyLevel` too, or create with
|
|
4935
|
+
`autoRecoverRateLimitErrors: false`.
|
|
4926
4936
|
Unlike the rest of the `ftp` object, a `PUT` that omits this field keeps the stored value instead of clearing it.
|
|
4927
4937
|
minimum: 1
|
|
4928
4938
|
maximum: 50
|
|
@@ -4932,8 +4942,9 @@ components:
|
|
|
4932
4942
|
targetConcurrencyLevel:
|
|
4933
4943
|
type: integer
|
|
4934
4944
|
description: |
|
|
4935
|
-
|
|
4936
|
-
|
|
4945
|
+
While `autoRecoverRateLimitErrors` is true, a create sets `concurrencyLevel` to this value, and a
|
|
4946
|
+
create that omits it gets 1 for both. Auto-recovery never runs on FTP connections (FTP errors
|
|
4947
|
+
aren't treated as rate limits), so nothing climbs back to it.
|
|
4937
4948
|
Kept on a `PUT` that omits it, like `concurrencyLevel`; unset by the save while
|
|
4938
4949
|
`autoRecoverRateLimitErrors` is false.
|
|
4939
4950
|
minimum: 1
|
|
@@ -4964,9 +4975,9 @@ components:
|
|
|
4964
4975
|
type: integer
|
|
4965
4976
|
readOnly: true
|
|
4966
4977
|
description: |-
|
|
4967
|
-
Server-maintained mirror of `multiThreadCount
|
|
4968
|
-
|
|
4969
|
-
recomputed on save.
|
|
4978
|
+
Server-maintained mirror of `multiThreadCount`, present while
|
|
4979
|
+
`autoRecoverRateLimitErrors` is true and `targetConcurrencyLevel` is
|
|
4980
|
+
set; recomputed on save.
|
|
4970
4981
|
if:
|
|
4971
4982
|
properties:
|
|
4972
4983
|
type:
|
|
@@ -9652,6 +9663,7 @@ components:
|
|
|
9652
9663
|
drops to 1 and climbs back toward the adaptor block's `targetConcurrencyLevel`, which is the
|
|
9653
9664
|
throughput lever while this is on. Turning it on copies the current `concurrencyLevel` into
|
|
9654
9665
|
the target; turning it off unsets the target and leaves `concurrencyLevel` at its current value.
|
|
9666
|
+
Recovery never runs on `ftp` connections: FTP errors aren't treated as rate limits.
|
|
9655
9667
|
__integrationIds:
|
|
9656
9668
|
type: array
|
|
9657
9669
|
maxItems: 100
|
package/dist/enduser.yml
CHANGED
|
@@ -2362,11 +2362,13 @@ components:
|
|
|
2362
2362
|
after which the flag switches itself off), and concurrency climbs back toward
|
|
2363
2363
|
`targetConcurrencyLevel`. While true, `targetConcurrencyLevel` is the throughput lever: a
|
|
2364
2364
|
`concurrencyLevel` sent in a PUT is ignored, and one sent in a PATCH is stored but the
|
|
2365
|
-
recovery machinery moves it back toward the target.
|
|
2365
|
+
recovery machinery moves it back toward the target. Recovery never runs on `ftp`
|
|
2366
|
+
connections: FTP errors aren't treated as rate limits.
|
|
2366
2367
|
x-celigo-ai-guidance:
|
|
2367
2368
|
- To change throughput while this is true, write `targetConcurrencyLevel`; a `concurrencyLevel` sent in a PUT returns 200 and changes nothing.
|
|
2368
2369
|
- Turning it on copies `concurrencyLevel` into `targetConcurrencyLevel`; turning it off unsets the target and leaves `concurrencyLevel` at its current value, which may be below the old target if a recovery was in progress. A `targetConcurrencyLevel` written while this is false is unset by the save.
|
|
2369
2370
|
- These four settings (`concurrencyLevel`, `targetConcurrencyLevel`, `_borrowConcurrencyFromConnectionId`, this flag) accept a credential-free `PATCH /v1/connections/{_id}`. A PUT replaces the whole document, so send each secret back as its masked `******` value (that keeps it) or as a new value, and never drop one to keep it — an omitted password or `http.encrypted` is cleared, and a static token left out (with no `refreshMethod`) fails the PUT with 422.
|
|
2371
|
+
- On an `ftp` connection recovery never runs, and transfer threads are `ftp.multiThreadCount`; while this is true a create sets `ftp.concurrencyLevel` to `ftp.targetConcurrencyLevel`, or to 1 without one.
|
|
2370
2372
|
enableMicroBatchForOneToMany:
|
|
2371
2373
|
type: boolean
|
|
2372
2374
|
default: true
|
|
@@ -2984,6 +2986,10 @@ components:
|
|
|
2984
2986
|
FTP servers often have low connection limits — keep this value conservative.
|
|
2985
2987
|
Send no more than the account's licensed maximum, the license's `concurrency` (25 standard,
|
|
2986
2988
|
50 with an Environments license).
|
|
2989
|
+
While `autoRecoverRateLimitErrors` is true, which a create gets unless it sends `false`, a create
|
|
2990
|
+
ignores the value sent here and sets this field to `targetConcurrencyLevel`, or to 1 when no
|
|
2991
|
+
target is sent. To start higher, send `targetConcurrencyLevel` too, or create with
|
|
2992
|
+
`autoRecoverRateLimitErrors: false`.
|
|
2987
2993
|
Unlike the rest of the `ftp` object, a `PUT` that omits this field keeps the stored value instead of clearing it.
|
|
2988
2994
|
minimum: 1
|
|
2989
2995
|
maximum: 50
|
|
@@ -2993,8 +2999,9 @@ components:
|
|
|
2993
2999
|
targetConcurrencyLevel:
|
|
2994
3000
|
type: integer
|
|
2995
3001
|
description: |
|
|
2996
|
-
|
|
2997
|
-
|
|
3002
|
+
While `autoRecoverRateLimitErrors` is true, a create sets `concurrencyLevel` to this value, and a
|
|
3003
|
+
create that omits it gets 1 for both. Auto-recovery never runs on FTP connections (FTP errors
|
|
3004
|
+
aren't treated as rate limits), so nothing climbs back to it.
|
|
2998
3005
|
Kept on a `PUT` that omits it, like `concurrencyLevel`; unset by the save while
|
|
2999
3006
|
`autoRecoverRateLimitErrors` is false.
|
|
3000
3007
|
minimum: 1
|
|
@@ -3025,9 +3032,9 @@ components:
|
|
|
3025
3032
|
type: integer
|
|
3026
3033
|
readOnly: true
|
|
3027
3034
|
description: |-
|
|
3028
|
-
Server-maintained mirror of `multiThreadCount
|
|
3029
|
-
|
|
3030
|
-
recomputed on save.
|
|
3035
|
+
Server-maintained mirror of `multiThreadCount`, present while
|
|
3036
|
+
`autoRecoverRateLimitErrors` is true and `targetConcurrencyLevel` is
|
|
3037
|
+
set; recomputed on save.
|
|
3031
3038
|
if:
|
|
3032
3039
|
properties:
|
|
3033
3040
|
type:
|
package/dist/export.yml
CHANGED
|
@@ -17666,6 +17666,18 @@ components:
|
|
|
17666
17666
|
example:
|
|
17667
17667
|
5f7c579b6411271af4e7cefa: 64a1234567890abcdef12345
|
|
17668
17668
|
5f7c579b6411271af4e7cefb: 64a1234567890abcdef12346
|
|
17669
|
+
_stackId:
|
|
17670
|
+
type: string
|
|
17671
|
+
format: objectId
|
|
17672
|
+
x-celigo-refModel: stacks
|
|
17673
|
+
description: |-
|
|
17674
|
+
Stack that every stack reference in the cloned resources (hooks and wrapper
|
|
17675
|
+
connections running on a stack) points at. Required when the clone preview reports
|
|
17676
|
+
`stackRequired: true`: without it the clone fails with 400 `stack_not_found`. The
|
|
17677
|
+
stack must belong to the target environment or be shared with it (404
|
|
17678
|
+
`stack_not_found` for an unknown id, 400 `invalid_stack` otherwise).
|
|
17679
|
+
examples:
|
|
17680
|
+
- 5f8d43a1b9e5a80011a35f2c
|
|
17669
17681
|
additionalProperties: true
|
|
17670
17682
|
CloneResponse:
|
|
17671
17683
|
description: Response body for a clone operation. Some clone endpoints return the cloned resource, while others may return a list of related created resources.
|
|
@@ -359,16 +359,20 @@ components:
|
|
|
359
359
|
type: string
|
|
360
360
|
description: |-
|
|
361
361
|
Base64-encoded EDI specification PDF. Must decode to a text-bearing
|
|
362
|
-
PDF
|
|
363
|
-
`
|
|
364
|
-
with `
|
|
362
|
+
PDF: a scanned or image-only document is accepted, and the job then
|
|
363
|
+
fails with `DETECTION_FAILED`. A value that isn't base64 or doesn't
|
|
364
|
+
decode to a PDF is rejected with `422 PDF_EXTRACTION_FAILED`, and
|
|
365
|
+
encoded payloads over 50 MB with `413 PAYLOAD_TOO_LARGE`.
|
|
365
366
|
documentType:
|
|
366
367
|
type: integer
|
|
367
368
|
description: |-
|
|
368
369
|
X12 transaction set number (e.g. 850), or 0 to auto-detect an
|
|
369
370
|
EDIFACT specification from the PDF contents. Values outside the
|
|
370
371
|
supported set fail with `400 INVALID_DOCUMENT_TYPE`; discover the
|
|
371
|
-
supported set via `GET /v1/filedefinitionrules/document-types`.
|
|
372
|
+
supported set via `GET /v1/filedefinitionrules/document-types`. A
|
|
373
|
+
supported value that names a different transaction set than the PDF
|
|
374
|
+
(an 850 guide submitted as 810) is accepted, and the job then fails
|
|
375
|
+
with `INVALID_DOCUMENT_TYPE`.
|
|
372
376
|
examples:
|
|
373
377
|
- 850
|
|
374
378
|
ErrorCode:
|
|
@@ -388,7 +392,7 @@ components:
|
|
|
388
392
|
- GENERATION_FAILED
|
|
389
393
|
- SERVICE_UNAVAILABLE
|
|
390
394
|
x-enumDescriptions:
|
|
391
|
-
INVALID_DOCUMENT_TYPE: documentType is not 0 and not a supported X12 set
|
|
395
|
+
INVALID_DOCUMENT_TYPE: documentType is not 0 and not a supported X12 set (400), or a failed job's PDF is not the submitted documentType
|
|
392
396
|
INVALID_REQUEST: Request body failed schema validation
|
|
393
397
|
UNAUTHORIZED: Missing or non-Bearer Authorization header
|
|
394
398
|
FORBIDDEN: Invalid, expired, or insufficient token or AShare
|
|
@@ -397,7 +401,7 @@ components:
|
|
|
397
401
|
RATE_LIMIT_EXCEEDED: Caller exceeded the endpoint token bucket
|
|
398
402
|
PDF_EXTRACTION_FAILED: pdf is not valid base64 or not a PDF
|
|
399
403
|
UNSUPPORTED_TYPE: Worker could not generate an FDR for the detected type
|
|
400
|
-
DETECTION_FAILED: Worker could not classify the PDF as X12 or EDIFACT
|
|
404
|
+
DETECTION_FAILED: Worker could not classify the PDF as X12 or EDIFACT, including a PDF with no text (a scanned or image-only one)
|
|
401
405
|
GENERATION_FAILED: Unexpected pipeline or server failure
|
|
402
406
|
SERVICE_UNAVAILABLE: Job store or PDF storage is unavailable
|
|
403
407
|
ErrorItem:
|
|
@@ -499,8 +503,10 @@ components:
|
|
|
499
503
|
code:
|
|
500
504
|
type: string
|
|
501
505
|
description: |-
|
|
502
|
-
Failure code — typically
|
|
503
|
-
|
|
506
|
+
Failure code — typically DETECTION_FAILED (no text to read, as in
|
|
507
|
+
a scanned or image-only PDF, or not recognizably X12 or EDIFACT),
|
|
508
|
+
INVALID_DOCUMENT_TYPE (the PDF is for a different transaction set
|
|
509
|
+
than `documentType`), UNSUPPORTED_TYPE, or GENERATION_FAILED.
|
|
504
510
|
examples:
|
|
505
511
|
- UNSUPPORTED_TYPE
|
|
506
512
|
message:
|
|
@@ -567,8 +573,10 @@ components:
|
|
|
567
573
|
code:
|
|
568
574
|
type: string
|
|
569
575
|
description: |-
|
|
570
|
-
Failure code — typically
|
|
571
|
-
|
|
576
|
+
Failure code — typically DETECTION_FAILED (no text to read, as in
|
|
577
|
+
a scanned or image-only PDF, or not recognizably X12 or EDIFACT),
|
|
578
|
+
INVALID_DOCUMENT_TYPE (the PDF is for a different transaction set
|
|
579
|
+
than `documentType`), UNSUPPORTED_TYPE, or GENERATION_FAILED.
|
|
572
580
|
message:
|
|
573
581
|
type: string
|
|
574
582
|
description: Human-readable failure reason.
|
package/dist/flow.yml
CHANGED
|
@@ -6207,6 +6207,18 @@ components:
|
|
|
6207
6207
|
example:
|
|
6208
6208
|
5f7c579b6411271af4e7cefa: 64a1234567890abcdef12345
|
|
6209
6209
|
5f7c579b6411271af4e7cefb: 64a1234567890abcdef12346
|
|
6210
|
+
_stackId:
|
|
6211
|
+
type: string
|
|
6212
|
+
format: objectId
|
|
6213
|
+
x-celigo-refModel: stacks
|
|
6214
|
+
description: |-
|
|
6215
|
+
Stack that every stack reference in the cloned resources (hooks and wrapper
|
|
6216
|
+
connections running on a stack) points at. Required when the clone preview reports
|
|
6217
|
+
`stackRequired: true`: without it the clone fails with 400 `stack_not_found`. The
|
|
6218
|
+
stack must belong to the target environment or be shared with it (404
|
|
6219
|
+
`stack_not_found` for an unknown id, 400 `invalid_stack` otherwise).
|
|
6220
|
+
examples:
|
|
6221
|
+
- 5f8d43a1b9e5a80011a35f2c
|
|
6210
6222
|
additionalProperties: true
|
|
6211
6223
|
CloneResponse:
|
|
6212
6224
|
description: Response body for a clone operation. Some clone endpoints return the cloned resource, while others may return a list of related created resources.
|
|
@@ -6264,12 +6276,18 @@ components:
|
|
|
6264
6276
|
additionalProperties: true
|
|
6265
6277
|
stackRequired:
|
|
6266
6278
|
type: boolean
|
|
6267
|
-
description:
|
|
6279
|
+
description: |-
|
|
6280
|
+
`true` when the resource or one of its dependencies references a stack (a hook or
|
|
6281
|
+
wrapper connection that runs on a stack). Send `_stackId` in the clone request: without
|
|
6282
|
+
it the clone fails with 400 `stack_not_found`.
|
|
6268
6283
|
_stackId:
|
|
6269
6284
|
type:
|
|
6270
6285
|
- string
|
|
6271
6286
|
- 'null'
|
|
6272
|
-
description:
|
|
6287
|
+
description: |-
|
|
6288
|
+
The first stack the resource or a dependency references, or null. Pass it, or another
|
|
6289
|
+
stack in the target environment, as `_stackId` in the clone request; the clone points
|
|
6290
|
+
every stack reference at that one stack.
|
|
6273
6291
|
examples:
|
|
6274
6292
|
- 5f8d43a1b9e5a80011a35f2c
|
|
6275
6293
|
FlowDescendantsResponse:
|
package/dist/import.yml
CHANGED
|
@@ -17773,6 +17773,18 @@ components:
|
|
|
17773
17773
|
example:
|
|
17774
17774
|
5f7c579b6411271af4e7cefa: 64a1234567890abcdef12345
|
|
17775
17775
|
5f7c579b6411271af4e7cefb: 64a1234567890abcdef12346
|
|
17776
|
+
_stackId:
|
|
17777
|
+
type: string
|
|
17778
|
+
format: objectId
|
|
17779
|
+
x-celigo-refModel: stacks
|
|
17780
|
+
description: |-
|
|
17781
|
+
Stack that every stack reference in the cloned resources (hooks and wrapper
|
|
17782
|
+
connections running on a stack) points at. Required when the clone preview reports
|
|
17783
|
+
`stackRequired: true`: without it the clone fails with 400 `stack_not_found`. The
|
|
17784
|
+
stack must belong to the target environment or be shared with it (404
|
|
17785
|
+
`stack_not_found` for an unknown id, 400 `invalid_stack` otherwise).
|
|
17786
|
+
examples:
|
|
17787
|
+
- 5f8d43a1b9e5a80011a35f2c
|
|
17776
17788
|
additionalProperties: true
|
|
17777
17789
|
CloneResponse:
|
|
17778
17790
|
description: Response body for a clone operation. Some clone endpoints return the cloned resource, while others may return a list of related created resources.
|
|
@@ -17823,12 +17835,18 @@ components:
|
|
|
17823
17835
|
additionalProperties: true
|
|
17824
17836
|
stackRequired:
|
|
17825
17837
|
type: boolean
|
|
17826
|
-
description:
|
|
17838
|
+
description: |-
|
|
17839
|
+
`true` when the resource or one of its dependencies references a stack (a hook or
|
|
17840
|
+
wrapper connection that runs on a stack). Send `_stackId` in the clone request: without
|
|
17841
|
+
it the clone fails with 400 `stack_not_found`.
|
|
17827
17842
|
_stackId:
|
|
17828
17843
|
type:
|
|
17829
17844
|
- string
|
|
17830
17845
|
- 'null'
|
|
17831
|
-
description:
|
|
17846
|
+
description: |-
|
|
17847
|
+
The first stack the resource or a dependency references, or null. Pass it, or another
|
|
17848
|
+
stack in the target environment, as `_stackId` in the clone request; the clone points
|
|
17849
|
+
every stack reference at that one stack.
|
|
17832
17850
|
examples:
|
|
17833
17851
|
- 5f8d43a1b9e5a80011a35f2c
|
|
17834
17852
|
ImportRecordResult:
|
package/dist/integration.yml
CHANGED
|
@@ -4609,6 +4609,18 @@ components:
|
|
|
4609
4609
|
example:
|
|
4610
4610
|
5f7c579b6411271af4e7cefa: 64a1234567890abcdef12345
|
|
4611
4611
|
5f7c579b6411271af4e7cefb: 64a1234567890abcdef12346
|
|
4612
|
+
_stackId:
|
|
4613
|
+
type: string
|
|
4614
|
+
format: objectId
|
|
4615
|
+
x-celigo-refModel: stacks
|
|
4616
|
+
description: |-
|
|
4617
|
+
Stack that every stack reference in the cloned resources (hooks and wrapper
|
|
4618
|
+
connections running on a stack) points at. Required when the clone preview reports
|
|
4619
|
+
`stackRequired: true`: without it the clone fails with 400 `stack_not_found`. The
|
|
4620
|
+
stack must belong to the target environment or be shared with it (404
|
|
4621
|
+
`stack_not_found` for an unknown id, 400 `invalid_stack` otherwise).
|
|
4622
|
+
examples:
|
|
4623
|
+
- 5f8d43a1b9e5a80011a35f2c
|
|
4612
4624
|
additionalProperties: true
|
|
4613
4625
|
CloneResponse:
|
|
4614
4626
|
description: Response body for a clone operation. Some clone endpoints return the cloned resource, while others may return a list of related created resources.
|
|
@@ -4669,12 +4681,18 @@ components:
|
|
|
4669
4681
|
additionalProperties: true
|
|
4670
4682
|
stackRequired:
|
|
4671
4683
|
type: boolean
|
|
4672
|
-
description:
|
|
4684
|
+
description: |-
|
|
4685
|
+
`true` when the resource or one of its dependencies references a stack (a hook or
|
|
4686
|
+
wrapper connection that runs on a stack). Send `_stackId` in the clone request: without
|
|
4687
|
+
it the clone fails with 400 `stack_not_found`.
|
|
4673
4688
|
_stackId:
|
|
4674
4689
|
type:
|
|
4675
4690
|
- string
|
|
4676
4691
|
- 'null'
|
|
4677
|
-
description:
|
|
4692
|
+
description: |-
|
|
4693
|
+
The first stack the resource or a dependency references, or null. Pass it, or another
|
|
4694
|
+
stack in the target environment, as `_stackId` in the clone request; the clone points
|
|
4695
|
+
every stack reference at that one stack.
|
|
4678
4696
|
examples:
|
|
4679
4697
|
- 5f8d43a1b9e5a80011a35f2c
|
|
4680
4698
|
Revision:
|
package/dist/lookupcache.yml
CHANGED
|
@@ -452,12 +452,14 @@ paths:
|
|
|
452
452
|
strings, or objects — arrays at the top level are rejected (wrap them in an
|
|
453
453
|
object). One invalid entry fails the entire batch and nothing in it is written:
|
|
454
454
|
a bad value returns `400 invalid_value`, an empty, missing, or over-length
|
|
455
|
-
key
|
|
456
|
-
|
|
455
|
+
key, or one holding a tab, newline, carriage return or NUL, returns
|
|
456
|
+
`400 cache_dynamodb_invalid_key`, and a key that appears twice in the batch
|
|
457
|
+
returns 400 "Duplicate keys found in the request".
|
|
457
458
|
|
|
458
|
-
|
|
459
|
-
Callers uploading more than that should
|
|
460
|
-
auto-batches at 1000 entries / 5 MB and concatenates
|
|
459
|
+
One request takes at most 1000 entries, each entry at most 64 KB, and at most 5 MB of
|
|
460
|
+
JSON in all (413, "request entity too large!"). Callers uploading more than that should
|
|
461
|
+
split their payload; the Celigo CLI auto-batches at 1000 entries / 5 MB and concatenates
|
|
462
|
+
the per-key results.
|
|
461
463
|
Each cache is capped at 50 MB and the per-environment aggregate is 1 GB.
|
|
462
464
|
parameters:
|
|
463
465
|
- name: _id
|
|
@@ -511,6 +513,17 @@ paths:
|
|
|
511
513
|
$ref: '#/components/responses/401-unauthorized'
|
|
512
514
|
'404':
|
|
513
515
|
$ref: '#/components/responses/404-not-found'
|
|
516
|
+
'413':
|
|
517
|
+
description: The request body is over 5 MB of JSON. Split the batch.
|
|
518
|
+
content:
|
|
519
|
+
application/json:
|
|
520
|
+
schema:
|
|
521
|
+
$ref: '#/components/schemas/Error'
|
|
522
|
+
examples:
|
|
523
|
+
too_large:
|
|
524
|
+
value:
|
|
525
|
+
errors:
|
|
526
|
+
- message: request entity too large!
|
|
514
527
|
delete:
|
|
515
528
|
x-internal: false
|
|
516
529
|
operationId: deleteLookupCacheDataKeys
|
|
@@ -1009,12 +1022,18 @@ components:
|
|
|
1009
1022
|
additionalProperties: true
|
|
1010
1023
|
stackRequired:
|
|
1011
1024
|
type: boolean
|
|
1012
|
-
description:
|
|
1025
|
+
description: |-
|
|
1026
|
+
`true` when the resource or one of its dependencies references a stack (a hook or
|
|
1027
|
+
wrapper connection that runs on a stack). Send `_stackId` in the clone request: without
|
|
1028
|
+
it the clone fails with 400 `stack_not_found`.
|
|
1013
1029
|
_stackId:
|
|
1014
1030
|
type:
|
|
1015
1031
|
- string
|
|
1016
1032
|
- 'null'
|
|
1017
|
-
description:
|
|
1033
|
+
description: |-
|
|
1034
|
+
The first stack the resource or a dependency references, or null. Pass it, or another
|
|
1035
|
+
stack in the target environment, as `_stackId` in the clone request; the clone points
|
|
1036
|
+
every stack reference at that one stack.
|
|
1018
1037
|
examples:
|
|
1019
1038
|
- 5f8d43a1b9e5a80011a35f2c
|
|
1020
1039
|
LookupCacheDataEntry:
|
|
@@ -1034,7 +1053,8 @@ components:
|
|
|
1034
1053
|
description: |-
|
|
1035
1054
|
Lookup key. Treated as an opaque string by the cache — case-sensitive, no
|
|
1036
1055
|
normalization. The same cache can hold multiple entries that differ only in
|
|
1037
|
-
case (e.g. `CA` and `ca`).
|
|
1056
|
+
case (e.g. `CA` and `ca`). An upsert also refuses a key that holds a tab, a newline,
|
|
1057
|
+
a carriage return or a NUL character, with the same `cache_dynamodb_invalid_key`.
|
|
1038
1058
|
examples:
|
|
1039
1059
|
- CA
|
|
1040
1060
|
- ext-customer-12345
|
|
@@ -1071,9 +1091,9 @@ components:
|
|
|
1071
1091
|
Request body for upserting key-value entries into a lookup cache. `data` must be
|
|
1072
1092
|
a non-empty array. Keys already present are overwritten; new keys are created.
|
|
1073
1093
|
|
|
1074
|
-
|
|
1075
|
-
more than that should split into multiple
|
|
1076
|
-
at 1000 entries / 5 MB).
|
|
1094
|
+
One request takes at most 1000 entries, each entry at most 64 KB, and at most 5 MB of
|
|
1095
|
+
JSON in all (413) — callers inserting more than that should split into multiple
|
|
1096
|
+
requests (the Celigo CLI auto-batches at 1000 entries / 5 MB).
|
|
1077
1097
|
properties:
|
|
1078
1098
|
data:
|
|
1079
1099
|
type: array
|
package/dist/marketplace.yml
CHANGED
|
@@ -154,9 +154,17 @@ paths:
|
|
|
154
154
|
`type` tells you which install route to use afterwards:
|
|
155
155
|
`POST /v1/integrations/template/{_id}` for `integration`,
|
|
156
156
|
`POST /v1/mcpservers/template/{_templateId}` for `mcpserver`.
|
|
157
|
-
`stackRequired` is `true` when the template
|
|
158
|
-
|
|
159
|
-
|
|
157
|
+
`stackRequired` is `true` when the template has hooks or wrapper
|
|
158
|
+
connections that run on a stack: the marketplace installer prompts for
|
|
159
|
+
one; `POST /v1/integrations/template/{_id}`, for a template it accepts
|
|
160
|
+
(no `template_zip` install step), needs it as `_stackId`; and an
|
|
161
|
+
MCP-server template's install adds a stack step to the integration it
|
|
162
|
+
creates.
|
|
163
|
+
|
|
164
|
+
Previewing an MCP-server template needs the same install permission as
|
|
165
|
+
installing it (403 for a monitor or integration-level user whose access
|
|
166
|
+
doesn't allow creating integrations); an integration template's preview
|
|
167
|
+
needs none.
|
|
160
168
|
|
|
161
169
|
The ID must belong to a Template, not a Connector (Integration App).
|
|
162
170
|
Connector IDs from `/v1/published` return 404 here -- pull template
|
|
@@ -234,6 +242,14 @@ paths:
|
|
|
234
242
|
concurrencyLevel: 1
|
|
235
243
|
'401':
|
|
236
244
|
$ref: '#/components/responses/401-unauthorized'
|
|
245
|
+
'403':
|
|
246
|
+
description: |-
|
|
247
|
+
An MCP-server template previewed by a user who may not install templates (a monitor
|
|
248
|
+
or integration-level user whose access doesn't allow creating integrations).
|
|
249
|
+
content:
|
|
250
|
+
application/json:
|
|
251
|
+
schema:
|
|
252
|
+
$ref: '#/components/schemas/Error'
|
|
237
253
|
'404':
|
|
238
254
|
description: |-
|
|
239
255
|
No template matched the id. Most commonly: the id belongs to a
|
|
@@ -887,10 +903,15 @@ components:
|
|
|
887
903
|
stackRequired:
|
|
888
904
|
type: boolean
|
|
889
905
|
description: |-
|
|
890
|
-
`true` when the template
|
|
891
|
-
that
|
|
892
|
-
|
|
893
|
-
|
|
906
|
+
`true` when the template has an export or import hook, or a wrapper
|
|
907
|
+
connection, that runs on a stack (a function with no script). The
|
|
908
|
+
marketplace installer asks for the stack. Through the API, an
|
|
909
|
+
integration template that `POST /v1/integrations/template/{_id}`
|
|
910
|
+
accepts (no `template_zip` install step) needs `_stackId` in the body,
|
|
911
|
+
or the install fails with 400 `stack_not_found`; so does a zip
|
|
912
|
+
installed with `POST /v1/integrations/template`. An MCP-server
|
|
913
|
+
template's install takes no body: the integration it creates for a
|
|
914
|
+
tool-bearing template gets a stack install step instead.
|
|
894
915
|
responses:
|
|
895
916
|
401-unauthorized:
|
|
896
917
|
description: |-
|
package/dist/mcp-server.yml
CHANGED
|
@@ -4198,11 +4198,13 @@ components:
|
|
|
4198
4198
|
after which the flag switches itself off), and concurrency climbs back toward
|
|
4199
4199
|
`targetConcurrencyLevel`. While true, `targetConcurrencyLevel` is the throughput lever: a
|
|
4200
4200
|
`concurrencyLevel` sent in a PUT is ignored, and one sent in a PATCH is stored but the
|
|
4201
|
-
recovery machinery moves it back toward the target.
|
|
4201
|
+
recovery machinery moves it back toward the target. Recovery never runs on `ftp`
|
|
4202
|
+
connections: FTP errors aren't treated as rate limits.
|
|
4202
4203
|
x-celigo-ai-guidance:
|
|
4203
4204
|
- To change throughput while this is true, write `targetConcurrencyLevel`; a `concurrencyLevel` sent in a PUT returns 200 and changes nothing.
|
|
4204
4205
|
- Turning it on copies `concurrencyLevel` into `targetConcurrencyLevel`; turning it off unsets the target and leaves `concurrencyLevel` at its current value, which may be below the old target if a recovery was in progress. A `targetConcurrencyLevel` written while this is false is unset by the save.
|
|
4205
4206
|
- These four settings (`concurrencyLevel`, `targetConcurrencyLevel`, `_borrowConcurrencyFromConnectionId`, this flag) accept a credential-free `PATCH /v1/connections/{_id}`. A PUT replaces the whole document, so send each secret back as its masked `******` value (that keeps it) or as a new value, and never drop one to keep it — an omitted password or `http.encrypted` is cleared, and a static token left out (with no `refreshMethod`) fails the PUT with 422.
|
|
4207
|
+
- On an `ftp` connection recovery never runs, and transfer threads are `ftp.multiThreadCount`; while this is true a create sets `ftp.concurrencyLevel` to `ftp.targetConcurrencyLevel`, or to 1 without one.
|
|
4206
4208
|
enableMicroBatchForOneToMany:
|
|
4207
4209
|
type: boolean
|
|
4208
4210
|
default: true
|
|
@@ -4820,6 +4822,10 @@ components:
|
|
|
4820
4822
|
FTP servers often have low connection limits — keep this value conservative.
|
|
4821
4823
|
Send no more than the account's licensed maximum, the license's `concurrency` (25 standard,
|
|
4822
4824
|
50 with an Environments license).
|
|
4825
|
+
While `autoRecoverRateLimitErrors` is true, which a create gets unless it sends `false`, a create
|
|
4826
|
+
ignores the value sent here and sets this field to `targetConcurrencyLevel`, or to 1 when no
|
|
4827
|
+
target is sent. To start higher, send `targetConcurrencyLevel` too, or create with
|
|
4828
|
+
`autoRecoverRateLimitErrors: false`.
|
|
4823
4829
|
Unlike the rest of the `ftp` object, a `PUT` that omits this field keeps the stored value instead of clearing it.
|
|
4824
4830
|
minimum: 1
|
|
4825
4831
|
maximum: 50
|
|
@@ -4829,8 +4835,9 @@ components:
|
|
|
4829
4835
|
targetConcurrencyLevel:
|
|
4830
4836
|
type: integer
|
|
4831
4837
|
description: |
|
|
4832
|
-
|
|
4833
|
-
|
|
4838
|
+
While `autoRecoverRateLimitErrors` is true, a create sets `concurrencyLevel` to this value, and a
|
|
4839
|
+
create that omits it gets 1 for both. Auto-recovery never runs on FTP connections (FTP errors
|
|
4840
|
+
aren't treated as rate limits), so nothing climbs back to it.
|
|
4834
4841
|
Kept on a `PUT` that omits it, like `concurrencyLevel`; unset by the save while
|
|
4835
4842
|
`autoRecoverRateLimitErrors` is false.
|
|
4836
4843
|
minimum: 1
|
|
@@ -4861,9 +4868,9 @@ components:
|
|
|
4861
4868
|
type: integer
|
|
4862
4869
|
readOnly: true
|
|
4863
4870
|
description: |-
|
|
4864
|
-
Server-maintained mirror of `multiThreadCount
|
|
4865
|
-
|
|
4866
|
-
recomputed on save.
|
|
4871
|
+
Server-maintained mirror of `multiThreadCount`, present while
|
|
4872
|
+
`autoRecoverRateLimitErrors` is true and `targetConcurrencyLevel` is
|
|
4873
|
+
set; recomputed on save.
|
|
4867
4874
|
if:
|
|
4868
4875
|
properties:
|
|
4869
4876
|
type:
|
package/dist/stack.yml
CHANGED
|
@@ -106,7 +106,7 @@ paths:
|
|
|
106
106
|
after creation via `GET /v1/stacks/{_id}/systemToken`.
|
|
107
107
|
x-celigo-ai-guidance:
|
|
108
108
|
- |-
|
|
109
|
-
- For `type=server`, provide `server.hostURI
|
|
109
|
+
- For `type=server`, provide `server.hostURI`. Don't send `server.ipRanges`: it's deprecated and nothing enforces it.
|
|
110
110
|
- For `type=lambda`, provide AWS credentials and function details under `lambda`.
|
|
111
111
|
operationId: createStack
|
|
112
112
|
tags:
|
package/dist/template.yml
CHANGED
|
@@ -22,8 +22,13 @@ tags:
|
|
|
22
22
|
|
|
23
23
|
The template lifecycle is: create → upload zip (via `GET /v1/s3SignedURL`) → publish.
|
|
24
24
|
|
|
25
|
-
|
|
26
|
-
receive 403
|
|
25
|
+
Creating, updating, uploading and publishing templates requires a
|
|
26
|
+
**Partner account** — non-partner callers receive 403
|
|
27
|
+
`access_restricted`. Installing a template (`/v1/integrations/template`
|
|
28
|
+
routes) needs install permission instead: the account owner,
|
|
29
|
+
administrators and manage users have it, and monitor or
|
|
30
|
+
integration-level users only when their access allows creating
|
|
31
|
+
integrations.
|
|
27
32
|
|
|
28
33
|
## Template schema
|
|
29
34
|
|
|
@@ -377,6 +382,18 @@ paths:
|
|
|
377
382
|
example:
|
|
378
383
|
61f92026dd053843b5d72350: 64a1234567890abcdef12345
|
|
379
384
|
61f92026dd053843b5d72351: 64a1234567890abcdef12346
|
|
385
|
+
_stackId:
|
|
386
|
+
type: string
|
|
387
|
+
format: objectId
|
|
388
|
+
x-celigo-refModel: stacks
|
|
389
|
+
description: |-
|
|
390
|
+
Stack for the template's hooks and wrapper connections that run on a stack.
|
|
391
|
+
Required when the template preview reports `stackRequired: true`: without
|
|
392
|
+
it the install fails with 400 `stack_not_found`. The stack must belong to
|
|
393
|
+
the environment or be shared with it (404 `stack_not_found` for an unknown
|
|
394
|
+
id, 400 `invalid_stack` otherwise).
|
|
395
|
+
examples:
|
|
396
|
+
- 5f8d43a1b9e5a80011a35f2c
|
|
380
397
|
required:
|
|
381
398
|
- connectionMap
|
|
382
399
|
examples:
|
|
@@ -419,9 +436,12 @@ paths:
|
|
|
419
436
|
_id: 6405b9d83496e05ff253d594
|
|
420
437
|
'400':
|
|
421
438
|
description: |-
|
|
422
|
-
Missing or empty `connectionMap
|
|
439
|
+
Missing or empty `connectionMap`; the template is an MCP server
|
|
423
440
|
template that must be installed through
|
|
424
|
-
`POST /v1/mcpservers/template/{_templateId}
|
|
441
|
+
`POST /v1/mcpservers/template/{_templateId}`; the template needs a
|
|
442
|
+
stack and the body has no `_stackId` (`stack_not_found`); or the
|
|
443
|
+
`_stackId` names a stack that neither belongs to this environment nor
|
|
444
|
+
is shared with it (`invalid_stack`).
|
|
425
445
|
content:
|
|
426
446
|
application/json:
|
|
427
447
|
schema:
|
|
@@ -438,12 +458,18 @@ paths:
|
|
|
438
458
|
errors:
|
|
439
459
|
- code: invalid_template
|
|
440
460
|
message: MCP server templates cannot be installed through the Integration template path.
|
|
461
|
+
missingStack:
|
|
462
|
+
summary: The preview reported stackRequired and no _stackId was sent
|
|
463
|
+
value:
|
|
464
|
+
errors:
|
|
465
|
+
- code: stack_not_found
|
|
466
|
+
message: The integration template has stack reference but _stackId not found in the request body.
|
|
441
467
|
'401':
|
|
442
468
|
$ref: '#/components/responses/401-unauthorized'
|
|
443
469
|
'403':
|
|
444
|
-
$ref: '#/components/responses/403-
|
|
470
|
+
$ref: '#/components/responses/403-cannot-install'
|
|
445
471
|
'404':
|
|
446
|
-
description: Template not found.
|
|
472
|
+
description: Template not found, or no stack has the `_stackId` sent (`stack_not_found`).
|
|
447
473
|
content:
|
|
448
474
|
application/json:
|
|
449
475
|
schema:
|
|
@@ -539,7 +565,7 @@ paths:
|
|
|
539
565
|
'401':
|
|
540
566
|
$ref: '#/components/responses/401-unauthorized'
|
|
541
567
|
'403':
|
|
542
|
-
$ref: '#/components/responses/403-
|
|
568
|
+
$ref: '#/components/responses/403-cannot-install'
|
|
543
569
|
'404':
|
|
544
570
|
description: The `runKey` does not match any uploaded zip.
|
|
545
571
|
content:
|
|
@@ -583,6 +609,16 @@ paths:
|
|
|
583
609
|
the template zip file.
|
|
584
610
|
examples:
|
|
585
611
|
- abc123def456
|
|
612
|
+
_stackId:
|
|
613
|
+
type: string
|
|
614
|
+
format: objectId
|
|
615
|
+
x-celigo-refModel: stacks
|
|
616
|
+
description: |-
|
|
617
|
+
Stack for the template's hooks and wrapper connections that run on a stack.
|
|
618
|
+
Required when the preview reports `stackRequired: true` (400
|
|
619
|
+
`stack_not_found` without it).
|
|
620
|
+
examples:
|
|
621
|
+
- 5f8d43a1b9e5a80011a35f2c
|
|
586
622
|
required:
|
|
587
623
|
- runKey
|
|
588
624
|
examples:
|
|
@@ -618,7 +654,7 @@ paths:
|
|
|
618
654
|
'401':
|
|
619
655
|
$ref: '#/components/responses/401-unauthorized'
|
|
620
656
|
'403':
|
|
621
|
-
$ref: '#/components/responses/403-
|
|
657
|
+
$ref: '#/components/responses/403-cannot-install'
|
|
622
658
|
'404':
|
|
623
659
|
description: The `runKey` does not match any uploaded zip.
|
|
624
660
|
content:
|
|
@@ -978,5 +1014,27 @@ components:
|
|
|
978
1014
|
errors:
|
|
979
1015
|
- code: invalid_request
|
|
980
1016
|
message: The request body failed validation.
|
|
1017
|
+
403-cannot-install:
|
|
1018
|
+
description: |-
|
|
1019
|
+
The caller may not install templates. The account owner, administrators and manage users
|
|
1020
|
+
can; a monitor user or a user with access to specific integrations only can install a
|
|
1021
|
+
template only when their access allows creating integrations
|
|
1022
|
+
(`allowIntegrationWorkspaceCreation`).
|
|
1023
|
+
content:
|
|
1024
|
+
application/json:
|
|
1025
|
+
schema:
|
|
1026
|
+
$ref: '#/components/schemas/Error'
|
|
1027
|
+
examples:
|
|
1028
|
+
cannotInstall:
|
|
1029
|
+
value:
|
|
1030
|
+
errors:
|
|
1031
|
+
- code: access_restricted
|
|
1032
|
+
message: Users with monitor or tile level manage permissions cannot install templates. Ask an account owner or administrator to increase your permissions, or contact another user with at least account level manage permissions to install the template.
|
|
1033
|
+
otherRole:
|
|
1034
|
+
summary: Any other role without install permission
|
|
1035
|
+
value:
|
|
1036
|
+
errors:
|
|
1037
|
+
- code: access_restricted
|
|
1038
|
+
message: The role which you are associated with doesn't have the required permissions to perform the action.
|
|
981
1039
|
x-enable-proxy: true
|
|
982
1040
|
x-internal: false
|
package/dist/tool.yml
CHANGED
|
@@ -776,6 +776,15 @@ paths:
|
|
|
776
776
|
format: objectId
|
|
777
777
|
examples:
|
|
778
778
|
- 6ac1ef4a38b24d95ffac2545: 6ac1ef4a38b24d95ffac2545
|
|
779
|
+
_stackId:
|
|
780
|
+
type: string
|
|
781
|
+
format: objectId
|
|
782
|
+
x-celigo-refModel: stacks
|
|
783
|
+
description: |-
|
|
784
|
+
Stack that the cloned steps' stack references point at. Required when the clone
|
|
785
|
+
preview reports `stackRequired: true` (400 `stack_not_found` without it).
|
|
786
|
+
examples:
|
|
787
|
+
- 5f8d43a1b9e5a80011a35f2c
|
|
779
788
|
examples:
|
|
780
789
|
default:
|
|
781
790
|
summary: Clone a tool with no connection-bearing steps into the same integration
|
|
@@ -7723,11 +7732,13 @@ components:
|
|
|
7723
7732
|
after which the flag switches itself off), and concurrency climbs back toward
|
|
7724
7733
|
`targetConcurrencyLevel`. While true, `targetConcurrencyLevel` is the throughput lever: a
|
|
7725
7734
|
`concurrencyLevel` sent in a PUT is ignored, and one sent in a PATCH is stored but the
|
|
7726
|
-
recovery machinery moves it back toward the target.
|
|
7735
|
+
recovery machinery moves it back toward the target. Recovery never runs on `ftp`
|
|
7736
|
+
connections: FTP errors aren't treated as rate limits.
|
|
7727
7737
|
x-celigo-ai-guidance:
|
|
7728
7738
|
- To change throughput while this is true, write `targetConcurrencyLevel`; a `concurrencyLevel` sent in a PUT returns 200 and changes nothing.
|
|
7729
7739
|
- Turning it on copies `concurrencyLevel` into `targetConcurrencyLevel`; turning it off unsets the target and leaves `concurrencyLevel` at its current value, which may be below the old target if a recovery was in progress. A `targetConcurrencyLevel` written while this is false is unset by the save.
|
|
7730
7740
|
- These four settings (`concurrencyLevel`, `targetConcurrencyLevel`, `_borrowConcurrencyFromConnectionId`, this flag) accept a credential-free `PATCH /v1/connections/{_id}`. A PUT replaces the whole document, so send each secret back as its masked `******` value (that keeps it) or as a new value, and never drop one to keep it — an omitted password or `http.encrypted` is cleared, and a static token left out (with no `refreshMethod`) fails the PUT with 422.
|
|
7741
|
+
- On an `ftp` connection recovery never runs, and transfer threads are `ftp.multiThreadCount`; while this is true a create sets `ftp.concurrencyLevel` to `ftp.targetConcurrencyLevel`, or to 1 without one.
|
|
7731
7742
|
enableMicroBatchForOneToMany:
|
|
7732
7743
|
type: boolean
|
|
7733
7744
|
default: true
|
|
@@ -8345,6 +8356,10 @@ components:
|
|
|
8345
8356
|
FTP servers often have low connection limits — keep this value conservative.
|
|
8346
8357
|
Send no more than the account's licensed maximum, the license's `concurrency` (25 standard,
|
|
8347
8358
|
50 with an Environments license).
|
|
8359
|
+
While `autoRecoverRateLimitErrors` is true, which a create gets unless it sends `false`, a create
|
|
8360
|
+
ignores the value sent here and sets this field to `targetConcurrencyLevel`, or to 1 when no
|
|
8361
|
+
target is sent. To start higher, send `targetConcurrencyLevel` too, or create with
|
|
8362
|
+
`autoRecoverRateLimitErrors: false`.
|
|
8348
8363
|
Unlike the rest of the `ftp` object, a `PUT` that omits this field keeps the stored value instead of clearing it.
|
|
8349
8364
|
minimum: 1
|
|
8350
8365
|
maximum: 50
|
|
@@ -8354,8 +8369,9 @@ components:
|
|
|
8354
8369
|
targetConcurrencyLevel:
|
|
8355
8370
|
type: integer
|
|
8356
8371
|
description: |
|
|
8357
|
-
|
|
8358
|
-
|
|
8372
|
+
While `autoRecoverRateLimitErrors` is true, a create sets `concurrencyLevel` to this value, and a
|
|
8373
|
+
create that omits it gets 1 for both. Auto-recovery never runs on FTP connections (FTP errors
|
|
8374
|
+
aren't treated as rate limits), so nothing climbs back to it.
|
|
8359
8375
|
Kept on a `PUT` that omits it, like `concurrencyLevel`; unset by the save while
|
|
8360
8376
|
`autoRecoverRateLimitErrors` is false.
|
|
8361
8377
|
minimum: 1
|
|
@@ -8386,9 +8402,9 @@ components:
|
|
|
8386
8402
|
type: integer
|
|
8387
8403
|
readOnly: true
|
|
8388
8404
|
description: |-
|
|
8389
|
-
Server-maintained mirror of `multiThreadCount
|
|
8390
|
-
|
|
8391
|
-
recomputed on save.
|
|
8405
|
+
Server-maintained mirror of `multiThreadCount`, present while
|
|
8406
|
+
`autoRecoverRateLimitErrors` is true and `targetConcurrencyLevel` is
|
|
8407
|
+
set; recomputed on save.
|
|
8392
8408
|
if:
|
|
8393
8409
|
properties:
|
|
8394
8410
|
type:
|
|
@@ -38466,12 +38482,18 @@ components:
|
|
|
38466
38482
|
additionalProperties: true
|
|
38467
38483
|
stackRequired:
|
|
38468
38484
|
type: boolean
|
|
38469
|
-
description:
|
|
38485
|
+
description: |-
|
|
38486
|
+
`true` when the resource or one of its dependencies references a stack (a hook or
|
|
38487
|
+
wrapper connection that runs on a stack). Send `_stackId` in the clone request: without
|
|
38488
|
+
it the clone fails with 400 `stack_not_found`.
|
|
38470
38489
|
_stackId:
|
|
38471
38490
|
type:
|
|
38472
38491
|
- string
|
|
38473
38492
|
- 'null'
|
|
38474
|
-
description:
|
|
38493
|
+
description: |-
|
|
38494
|
+
The first stack the resource or a dependency references, or null. Pass it, or another
|
|
38495
|
+
stack in the target environment, as `_stackId` in the clone request; the clone points
|
|
38496
|
+
every stack reference at that one stack.
|
|
38475
38497
|
examples:
|
|
38476
38498
|
- 5f8d43a1b9e5a80011a35f2c
|
|
38477
38499
|
DependencyEntry:
|
package/package.json
CHANGED