@celigo/api-specs 0.2.5 → 0.2.7
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/connection.yml +13 -4
- package/dist/flow.yml +23 -7
- package/dist/job.yml +8 -0
- package/dist/tool.yml +13 -4
- package/package.json +1 -1
- package/schemas.json +2 -2
package/dist/connection.yml
CHANGED
|
@@ -2445,7 +2445,15 @@ components:
|
|
|
2445
2445
|
autoRecoverRateLimitErrors:
|
|
2446
2446
|
type: boolean
|
|
2447
2447
|
default: true
|
|
2448
|
-
description:
|
|
2448
|
+
description: |-
|
|
2449
|
+
When true, rate-limit errors from the target system trigger automatic recovery: concurrency
|
|
2450
|
+
drops to 1, the rate-limited requests are retried with doubling waits (1 to 1024 minutes,
|
|
2451
|
+
after which the flag switches itself off), and concurrency climbs back toward
|
|
2452
|
+
`targetConcurrencyLevel`. While true, `concurrencyLevel` is platform-managed and writes to
|
|
2453
|
+
it are ignored — `targetConcurrencyLevel` is the lever.
|
|
2454
|
+
x-celigo-ai-guidance:
|
|
2455
|
+
- To change throughput while this is true, write `targetConcurrencyLevel`; a `concurrencyLevel` write returns 200 and changes nothing.
|
|
2456
|
+
- Turning it on copies `concurrencyLevel` into `targetConcurrencyLevel`; turning it off copies the target back into `concurrencyLevel` and unsets the target.
|
|
2449
2457
|
enableMicroBatchForOneToMany:
|
|
2450
2458
|
type: boolean
|
|
2451
2459
|
default: true
|
|
@@ -3722,16 +3730,17 @@ components:
|
|
|
3722
3730
|
Higher values increase throughput but may trigger API rate limits.
|
|
3723
3731
|
Set this based on the target API's rate limit documentation.
|
|
3724
3732
|
Values above the account's licensed maximum (25 standard, 50 with an Environments license) are silently clamped down.
|
|
3733
|
+
Platform-managed while `autoRecoverRateLimitErrors` is true — writes are ignored; set `targetConcurrencyLevel` instead.
|
|
3725
3734
|
minimum: 1
|
|
3726
3735
|
maximum: 50
|
|
3727
3736
|
default: 25
|
|
3728
3737
|
targetConcurrencyLevel:
|
|
3729
3738
|
type: number
|
|
3730
3739
|
description: |
|
|
3731
|
-
|
|
3732
|
-
|
|
3740
|
+
Ceiling the platform climbs back to after rate-limit recovery, in steps of 25% of this value.
|
|
3741
|
+
Writing it also sets `concurrencyLevel` to the same value and stops any recovery in progress.
|
|
3733
3742
|
|
|
3734
|
-
|
|
3743
|
+
Honored only while `autoRecoverRateLimitErrors` is true; ignored, and unset, when it is false.
|
|
3735
3744
|
minimum: 1
|
|
3736
3745
|
maximum: 50
|
|
3737
3746
|
examples:
|
package/dist/flow.yml
CHANGED
|
@@ -5333,10 +5333,18 @@ components:
|
|
|
5333
5333
|
- false
|
|
5334
5334
|
autoResolveMatchingTraceKeys:
|
|
5335
5335
|
type: boolean
|
|
5336
|
-
|
|
5336
|
+
default: true
|
|
5337
|
+
description: |-
|
|
5338
|
+
When true, a new error for a record whose trace key already has open errors on the same step
|
|
5339
|
+
auto-resolves the older ones, a later success for that record auto-resolves its open errors,
|
|
5340
|
+
and errors classified `intermittent` are retried automatically — up to four attempts, the
|
|
5341
|
+
first about 30 minutes after the error.
|
|
5337
5342
|
examples:
|
|
5338
5343
|
- true
|
|
5339
5344
|
- false
|
|
5345
|
+
x-celigo-ai-guidance:
|
|
5346
|
+
- Both behaviors hang off this one flag — off means repeated failures of a record stay open and intermittent errors get no automatic retries; never turn it off as a fix for "duplicate" errors (those come from the destination, not from trace keys).
|
|
5347
|
+
- Intermittent auto-retry does not depend on the trace key — errors with a blank trace key are scheduled and retried the same way; a blank key only loses the duplicate collapse.
|
|
5340
5348
|
isAbstract:
|
|
5341
5349
|
type: boolean
|
|
5342
5350
|
description: |-
|
|
@@ -6102,13 +6110,18 @@ components:
|
|
|
6102
6110
|
classification:
|
|
6103
6111
|
type: string
|
|
6104
6112
|
description: |-
|
|
6105
|
-
Category
|
|
6106
|
-
|
|
6113
|
+
Category the platform derives from the error's code, message, and source — read-only, never
|
|
6114
|
+
set by users; `intermittent` errors are retried automatically while the flow's
|
|
6115
|
+
`autoResolveMatchingTraceKeys` is on. Absent when nothing matched with confidence. The value
|
|
6116
|
+
set is the `classification` dimension of the errors filter metadata.
|
|
6107
6117
|
examples:
|
|
6108
6118
|
- intermittent
|
|
6119
|
+
x-celigo-ai-guidance:
|
|
6120
|
+
- Read the classification off the record; never infer it from the message text — the classifier is heuristic and identical messages can classify differently.
|
|
6121
|
+
- There is no setting, mapping, hook, or API that changes a classification; a wrong one is a Celigo Support matter.
|
|
6109
6122
|
classifiedBy:
|
|
6110
6123
|
type: string
|
|
6111
|
-
description: '`auto`
|
|
6124
|
+
description: '`auto` on every classified error; absent on unclassified ones.'
|
|
6112
6125
|
examples:
|
|
6113
6126
|
- auto
|
|
6114
6127
|
reqAndResKey:
|
|
@@ -6140,11 +6153,14 @@ components:
|
|
|
6140
6153
|
type: string
|
|
6141
6154
|
format: date-time
|
|
6142
6155
|
description: |-
|
|
6143
|
-
|
|
6144
|
-
|
|
6145
|
-
|
|
6156
|
+
Present while the platform is auto-retrying this `intermittent` error. On a first-occurrence
|
|
6157
|
+
error it is stamped about a minute after `occurredAt` and is not the first attempt time (that
|
|
6158
|
+
runs roughly 30 minutes out); on the error a failed attempt opens, it is the next scheduled
|
|
6159
|
+
attempt. Absent once the attempts are exhausted and on errors that are not auto-retried.
|
|
6146
6160
|
examples:
|
|
6147
6161
|
- '2026-01-15T09:35:00.000Z'
|
|
6162
|
+
x-celigo-ai-guidance:
|
|
6163
|
+
- Presence answers "is this error in auto-retry mode?"; the value is a real schedule only after at least one attempt has run.
|
|
6148
6164
|
tags:
|
|
6149
6165
|
type:
|
|
6150
6166
|
- array
|
package/dist/job.yml
CHANGED
|
@@ -1707,8 +1707,16 @@ components:
|
|
|
1707
1707
|
Omitting `time_gt` does not mean "all history" — the endpoint falls back to the dashboard's
|
|
1708
1708
|
default window (approximately the last 24 hours), and runs older than that silently drop out
|
|
1709
1709
|
of every aggregate. Send `time_gt` (epoch milliseconds) explicitly for any other range.
|
|
1710
|
+
|
|
1711
|
+
`time_lte` must not be later than the current time: a future value is rejected with
|
|
1712
|
+
`400 invalid_filter_request_body` (unlike `POST /v1/jobs/current`, which accepts it). Omit
|
|
1713
|
+
`time_lte` to end the window at now. When both bounds are sent they must be at least one hour
|
|
1714
|
+
apart (`time_lte - time_gt >= 3600000`), or the request is rejected with
|
|
1715
|
+
`400 invalid_time_filter`; a window with `time_gt` alone has no minimum span.
|
|
1710
1716
|
x-celigo-ai-guidance:
|
|
1711
1717
|
- Always send an explicit time_gt matching the window you intend to report, and never present the aggregates as covering a longer period than the time filter you sent. Without time_gt the default window (~24 hours) applies — an empty result then means "nothing ran recently", never "no runs exist".
|
|
1718
|
+
- For a window that runs through the present, omit time_lte rather than computing an end bound — a value even seconds ahead of the server clock (a rounded-up "now", end of today) fails the whole request with 400 invalid_filter_request_body.
|
|
1719
|
+
- A closed window narrower than one hour cannot be queried; widen time_lte to time_gt + one hour (and say so when reporting) rather than sending the narrower range.
|
|
1712
1720
|
- A flow absent from stats[] had no runs in the window; it does not mean the flow does not exist. numOpenError counts errors open NOW, which may predate the window.
|
|
1713
1721
|
FlowRunStatsEntry:
|
|
1714
1722
|
type: object
|
package/dist/tool.yml
CHANGED
|
@@ -4883,7 +4883,15 @@ components:
|
|
|
4883
4883
|
autoRecoverRateLimitErrors:
|
|
4884
4884
|
type: boolean
|
|
4885
4885
|
default: true
|
|
4886
|
-
description:
|
|
4886
|
+
description: |-
|
|
4887
|
+
When true, rate-limit errors from the target system trigger automatic recovery: concurrency
|
|
4888
|
+
drops to 1, the rate-limited requests are retried with doubling waits (1 to 1024 minutes,
|
|
4889
|
+
after which the flag switches itself off), and concurrency climbs back toward
|
|
4890
|
+
`targetConcurrencyLevel`. While true, `concurrencyLevel` is platform-managed and writes to
|
|
4891
|
+
it are ignored — `targetConcurrencyLevel` is the lever.
|
|
4892
|
+
x-celigo-ai-guidance:
|
|
4893
|
+
- To change throughput while this is true, write `targetConcurrencyLevel`; a `concurrencyLevel` write returns 200 and changes nothing.
|
|
4894
|
+
- Turning it on copies `concurrencyLevel` into `targetConcurrencyLevel`; turning it off copies the target back into `concurrencyLevel` and unsets the target.
|
|
4887
4895
|
enableMicroBatchForOneToMany:
|
|
4888
4896
|
type: boolean
|
|
4889
4897
|
default: true
|
|
@@ -6160,16 +6168,17 @@ components:
|
|
|
6160
6168
|
Higher values increase throughput but may trigger API rate limits.
|
|
6161
6169
|
Set this based on the target API's rate limit documentation.
|
|
6162
6170
|
Values above the account's licensed maximum (25 standard, 50 with an Environments license) are silently clamped down.
|
|
6171
|
+
Platform-managed while `autoRecoverRateLimitErrors` is true — writes are ignored; set `targetConcurrencyLevel` instead.
|
|
6163
6172
|
minimum: 1
|
|
6164
6173
|
maximum: 50
|
|
6165
6174
|
default: 25
|
|
6166
6175
|
targetConcurrencyLevel:
|
|
6167
6176
|
type: number
|
|
6168
6177
|
description: |
|
|
6169
|
-
|
|
6170
|
-
|
|
6178
|
+
Ceiling the platform climbs back to after rate-limit recovery, in steps of 25% of this value.
|
|
6179
|
+
Writing it also sets `concurrencyLevel` to the same value and stops any recovery in progress.
|
|
6171
6180
|
|
|
6172
|
-
|
|
6181
|
+
Honored only while `autoRecoverRateLimitErrors` is true; ignored, and unset, when it is false.
|
|
6173
6182
|
minimum: 1
|
|
6174
6183
|
maximum: 50
|
|
6175
6184
|
examples:
|
package/package.json
CHANGED