@celigo/api-specs 0.2.174 → 0.2.176
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/api.yml +3 -2
- package/dist/connection.yml +16 -2
- package/dist/enduser.yml +3 -2
- package/dist/filedefinitionrules.yml +18 -10
- package/dist/mcp-server.yml +3 -2
- package/dist/tool.yml +3 -2
- package/package.json +1 -1
- package/schemas.json +1 -1
package/dist/api.yml
CHANGED
|
@@ -5460,7 +5460,8 @@ components:
|
|
|
5460
5460
|
- To change throughput while this is true, write `targetConcurrencyLevel`; a `concurrencyLevel` sent in a PUT returns 200 and changes nothing.
|
|
5461
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.
|
|
5462
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
|
|
5463
|
+
- On a create, while this is true, set the level with `targetConcurrencyLevel`: on `http`, `ftp`, `rdbms` and `mongodb` connections the save stores the target sent, or the adaptor's default without one (1 for `ftp`, 5 for `rdbms` and `mongodb`, 25 for `http` where the license's `concurrency` is at least 25), as both fields, whatever `concurrencyLevel` the body carried. A create that sends this as `false` keeps its `concurrencyLevel`.
|
|
5464
|
+
- On an `ftp` connection recovery never runs, and transfer threads are `ftp.multiThreadCount`.
|
|
5464
5465
|
enableMicroBatchForOneToMany:
|
|
5465
5466
|
type: boolean
|
|
5466
5467
|
default: true
|
|
@@ -6827,7 +6828,7 @@ components:
|
|
|
6827
6828
|
Send no more than the account's licensed maximum (25 standard, 50 with an Environments license).
|
|
6828
6829
|
A decimal is rejected with 422 `invalid_field_value` on every write (the same rule applies to every
|
|
6829
6830
|
adaptor's `concurrencyLevel` and `targetConcurrencyLevel`, and to `ftp.multiThreadCount`).
|
|
6830
|
-
Platform-managed while `autoRecoverRateLimitErrors` is true — a PUT ignores the value and the recovery machinery moves it toward the target; set `targetConcurrencyLevel` instead.
|
|
6831
|
+
Platform-managed while `autoRecoverRateLimitErrors` is true — a create or PUT ignores the value (a create without `targetConcurrencyLevel` stores 25 where the license's `concurrency` is at least 25) and the recovery machinery moves it toward the target; set `targetConcurrencyLevel` instead.
|
|
6831
6832
|
At level 1 an import's pages run one at a time, so a record's existence lookup and write finish before the next record's start (measured on a single import); the import's `idLockTemplate` serializes only same-key records and leaves the rest parallel.
|
|
6832
6833
|
minimum: 1
|
|
6833
6834
|
maximum: 50
|
package/dist/connection.yml
CHANGED
|
@@ -721,6 +721,12 @@ paths:
|
|
|
721
721
|
in clear on create and come back masked as "******"; the response also carries the
|
|
722
722
|
server-populated fields (`connectionRole: standard`, `concurrencyLevel`,
|
|
723
723
|
`targetConcurrencyLevel`, `microServices`).
|
|
724
|
+
- |-
|
|
725
|
+
Choose the level with `targetConcurrencyLevel`, or send `autoRecoverRateLimitErrors: false`
|
|
726
|
+
with `concurrencyLevel`. While auto-recovery is on, which a create gets unless it sends
|
|
727
|
+
`false`, an `http`, `ftp`, `rdbms` or `mongodb` create replaces a `concurrencyLevel` sent
|
|
728
|
+
without a target with the adaptor's default, so an `http` create that asks for 10 is stored at
|
|
729
|
+
25 where the license's `concurrency` is at least 25 (see `autoRecoverRateLimitErrors`).
|
|
724
730
|
/v1/connections/{_id}:
|
|
725
731
|
get:
|
|
726
732
|
x-internal: false
|
|
@@ -4311,7 +4317,8 @@ components:
|
|
|
4311
4317
|
- To change throughput while this is true, write `targetConcurrencyLevel`; a `concurrencyLevel` sent in a PUT returns 200 and changes nothing.
|
|
4312
4318
|
- 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.
|
|
4313
4319
|
- 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
|
|
4320
|
+
- On a create, while this is true, set the level with `targetConcurrencyLevel`: on `http`, `ftp`, `rdbms` and `mongodb` connections the save stores the target sent, or the adaptor's default without one (1 for `ftp`, 5 for `rdbms` and `mongodb`, 25 for `http` where the license's `concurrency` is at least 25), as both fields, whatever `concurrencyLevel` the body carried. A create that sends this as `false` keeps its `concurrencyLevel`.
|
|
4321
|
+
- On an `ftp` connection recovery never runs, and transfer threads are `ftp.multiThreadCount`.
|
|
4315
4322
|
enableMicroBatchForOneToMany:
|
|
4316
4323
|
type: boolean
|
|
4317
4324
|
default: true
|
|
@@ -5678,7 +5685,7 @@ components:
|
|
|
5678
5685
|
Send no more than the account's licensed maximum (25 standard, 50 with an Environments license).
|
|
5679
5686
|
A decimal is rejected with 422 `invalid_field_value` on every write (the same rule applies to every
|
|
5680
5687
|
adaptor's `concurrencyLevel` and `targetConcurrencyLevel`, and to `ftp.multiThreadCount`).
|
|
5681
|
-
Platform-managed while `autoRecoverRateLimitErrors` is true — a PUT ignores the value and the recovery machinery moves it toward the target; set `targetConcurrencyLevel` instead.
|
|
5688
|
+
Platform-managed while `autoRecoverRateLimitErrors` is true — a create or PUT ignores the value (a create without `targetConcurrencyLevel` stores 25 where the license's `concurrency` is at least 25) and the recovery machinery moves it toward the target; set `targetConcurrencyLevel` instead.
|
|
5682
5689
|
At level 1 an import's pages run one at a time, so a record's existence lookup and write finish before the next record's start (measured on a single import); the import's `idLockTemplate` serializes only same-key records and leaves the rest parallel.
|
|
5683
5690
|
minimum: 1
|
|
5684
5691
|
maximum: 50
|
|
@@ -9663,6 +9670,13 @@ components:
|
|
|
9663
9670
|
drops to 1 and climbs back toward the adaptor block's `targetConcurrencyLevel`, which is the
|
|
9664
9671
|
throughput lever while this is on. Turning it on copies the current `concurrencyLevel` into
|
|
9665
9672
|
the target; turning it off unsets the target and leaves `concurrencyLevel` at its current value.
|
|
9673
|
+
A create gets `true` unless it sends `false`; while it is true, set a new connection's level
|
|
9674
|
+
with `targetConcurrencyLevel`. On `http`, `ftp`, `rdbms` and `mongodb` connections the create
|
|
9675
|
+
stores the target sent, or the adaptor's default without one, as both `concurrencyLevel` and
|
|
9676
|
+
`targetConcurrencyLevel`, whatever `concurrencyLevel` the body carried: 1 for `ftp`, 5 for
|
|
9677
|
+
`rdbms` and `mongodb`, and 25 for `http` where the license's `concurrency` is at least 25, so
|
|
9678
|
+
such an `http` create that sends only `concurrencyLevel: 10` is stored at 25. To keep the
|
|
9679
|
+
`concurrencyLevel` you send, create with this `false`.
|
|
9666
9680
|
Recovery never runs on `ftp` connections: FTP errors aren't treated as rate limits.
|
|
9667
9681
|
__integrationIds:
|
|
9668
9682
|
type: array
|
package/dist/enduser.yml
CHANGED
|
@@ -2368,7 +2368,8 @@ components:
|
|
|
2368
2368
|
- To change throughput while this is true, write `targetConcurrencyLevel`; a `concurrencyLevel` sent in a PUT returns 200 and changes nothing.
|
|
2369
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.
|
|
2370
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
|
|
2371
|
+
- On a create, while this is true, set the level with `targetConcurrencyLevel`: on `http`, `ftp`, `rdbms` and `mongodb` connections the save stores the target sent, or the adaptor's default without one (1 for `ftp`, 5 for `rdbms` and `mongodb`, 25 for `http` where the license's `concurrency` is at least 25), as both fields, whatever `concurrencyLevel` the body carried. A create that sends this as `false` keeps its `concurrencyLevel`.
|
|
2372
|
+
- On an `ftp` connection recovery never runs, and transfer threads are `ftp.multiThreadCount`.
|
|
2372
2373
|
enableMicroBatchForOneToMany:
|
|
2373
2374
|
type: boolean
|
|
2374
2375
|
default: true
|
|
@@ -3735,7 +3736,7 @@ components:
|
|
|
3735
3736
|
Send no more than the account's licensed maximum (25 standard, 50 with an Environments license).
|
|
3736
3737
|
A decimal is rejected with 422 `invalid_field_value` on every write (the same rule applies to every
|
|
3737
3738
|
adaptor's `concurrencyLevel` and `targetConcurrencyLevel`, and to `ftp.multiThreadCount`).
|
|
3738
|
-
Platform-managed while `autoRecoverRateLimitErrors` is true — a PUT ignores the value and the recovery machinery moves it toward the target; set `targetConcurrencyLevel` instead.
|
|
3739
|
+
Platform-managed while `autoRecoverRateLimitErrors` is true — a create or PUT ignores the value (a create without `targetConcurrencyLevel` stores 25 where the license's `concurrency` is at least 25) and the recovery machinery moves it toward the target; set `targetConcurrencyLevel` instead.
|
|
3739
3740
|
At level 1 an import's pages run one at a time, so a record's existence lookup and write finish before the next record's start (measured on a single import); the import's `idLockTemplate` serializes only same-key records and leaves the rest parallel.
|
|
3740
3741
|
minimum: 1
|
|
3741
3742
|
maximum: 50
|
|
@@ -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/mcp-server.yml
CHANGED
|
@@ -4204,7 +4204,8 @@ components:
|
|
|
4204
4204
|
- To change throughput while this is true, write `targetConcurrencyLevel`; a `concurrencyLevel` sent in a PUT returns 200 and changes nothing.
|
|
4205
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.
|
|
4206
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
|
|
4207
|
+
- On a create, while this is true, set the level with `targetConcurrencyLevel`: on `http`, `ftp`, `rdbms` and `mongodb` connections the save stores the target sent, or the adaptor's default without one (1 for `ftp`, 5 for `rdbms` and `mongodb`, 25 for `http` where the license's `concurrency` is at least 25), as both fields, whatever `concurrencyLevel` the body carried. A create that sends this as `false` keeps its `concurrencyLevel`.
|
|
4208
|
+
- On an `ftp` connection recovery never runs, and transfer threads are `ftp.multiThreadCount`.
|
|
4208
4209
|
enableMicroBatchForOneToMany:
|
|
4209
4210
|
type: boolean
|
|
4210
4211
|
default: true
|
|
@@ -5571,7 +5572,7 @@ components:
|
|
|
5571
5572
|
Send no more than the account's licensed maximum (25 standard, 50 with an Environments license).
|
|
5572
5573
|
A decimal is rejected with 422 `invalid_field_value` on every write (the same rule applies to every
|
|
5573
5574
|
adaptor's `concurrencyLevel` and `targetConcurrencyLevel`, and to `ftp.multiThreadCount`).
|
|
5574
|
-
Platform-managed while `autoRecoverRateLimitErrors` is true — a PUT ignores the value and the recovery machinery moves it toward the target; set `targetConcurrencyLevel` instead.
|
|
5575
|
+
Platform-managed while `autoRecoverRateLimitErrors` is true — a create or PUT ignores the value (a create without `targetConcurrencyLevel` stores 25 where the license's `concurrency` is at least 25) and the recovery machinery moves it toward the target; set `targetConcurrencyLevel` instead.
|
|
5575
5576
|
At level 1 an import's pages run one at a time, so a record's existence lookup and write finish before the next record's start (measured on a single import); the import's `idLockTemplate` serializes only same-key records and leaves the rest parallel.
|
|
5576
5577
|
minimum: 1
|
|
5577
5578
|
maximum: 50
|
package/dist/tool.yml
CHANGED
|
@@ -7738,7 +7738,8 @@ components:
|
|
|
7738
7738
|
- To change throughput while this is true, write `targetConcurrencyLevel`; a `concurrencyLevel` sent in a PUT returns 200 and changes nothing.
|
|
7739
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.
|
|
7740
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
|
|
7741
|
+
- On a create, while this is true, set the level with `targetConcurrencyLevel`: on `http`, `ftp`, `rdbms` and `mongodb` connections the save stores the target sent, or the adaptor's default without one (1 for `ftp`, 5 for `rdbms` and `mongodb`, 25 for `http` where the license's `concurrency` is at least 25), as both fields, whatever `concurrencyLevel` the body carried. A create that sends this as `false` keeps its `concurrencyLevel`.
|
|
7742
|
+
- On an `ftp` connection recovery never runs, and transfer threads are `ftp.multiThreadCount`.
|
|
7742
7743
|
enableMicroBatchForOneToMany:
|
|
7743
7744
|
type: boolean
|
|
7744
7745
|
default: true
|
|
@@ -9105,7 +9106,7 @@ components:
|
|
|
9105
9106
|
Send no more than the account's licensed maximum (25 standard, 50 with an Environments license).
|
|
9106
9107
|
A decimal is rejected with 422 `invalid_field_value` on every write (the same rule applies to every
|
|
9107
9108
|
adaptor's `concurrencyLevel` and `targetConcurrencyLevel`, and to `ftp.multiThreadCount`).
|
|
9108
|
-
Platform-managed while `autoRecoverRateLimitErrors` is true — a PUT ignores the value and the recovery machinery moves it toward the target; set `targetConcurrencyLevel` instead.
|
|
9109
|
+
Platform-managed while `autoRecoverRateLimitErrors` is true — a create or PUT ignores the value (a create without `targetConcurrencyLevel` stores 25 where the license's `concurrency` is at least 25) and the recovery machinery moves it toward the target; set `targetConcurrencyLevel` instead.
|
|
9109
9110
|
At level 1 an import's pages run one at a time, so a record's existence lookup and write finish before the next record's start (measured on a single import); the import's `idLockTemplate` serializes only same-key records and leaves the rest parallel.
|
|
9110
9111
|
minimum: 1
|
|
9111
9112
|
maximum: 50
|
package/package.json
CHANGED