@celigo/api-specs 0.2.147 → 0.2.148
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 -8
- package/dist/flow.yml +13 -8
- package/dist/tool.yml +11 -8
- package/package.json +1 -1
- package/schemas.json +1 -1
package/dist/export.yml
CHANGED
|
@@ -984,10 +984,13 @@ components:
|
|
|
984
984
|
description: |-
|
|
985
985
|
Configures incremental exports that retrieve only records created or modified since the last
|
|
986
986
|
successful run. Required when the export's type is "delta"; omit for other export types.
|
|
987
|
-
|
|
988
|
-
|
|
989
|
-
|
|
990
|
-
|
|
987
|
+
The platform-managed last-successful-run timestamp (exposed as {{lastExportDateTime}}) is the
|
|
988
|
+
lower bound, and after a failed run the next run reuses the last successful timestamp so
|
|
989
|
+
changed records are not missed. A first run is not a full export: with no `startDate`, its
|
|
990
|
+
{{lastExportDateTime}} is the run's own timestamp (the value {{currentExportDateTime}} also
|
|
991
|
+
holds), so it picks up no earlier changes. Set `startDate` to reach back further. On success,
|
|
992
|
+
when `POST /v1/flows/{_id}/run` sends `export.endDate`, the flow's checkpoint is left at that
|
|
993
|
+
value, so an end date in the past moves the next run's lower bound back.
|
|
991
994
|
x-celigo-ai-guidance:
|
|
992
995
|
- |-
|
|
993
996
|
This object is REQUIRED when the export's type field is set to "delta" and
|
|
@@ -1023,7 +1026,7 @@ components:
|
|
|
1023
1026
|
|
|
1024
1027
|
2. The system automatically maintains the last successful run timestamp
|
|
1025
1028
|
- No need to store or manage timestamps in your own code
|
|
1026
|
-
-
|
|
1029
|
+
- A first run without ``startDate`` fetches nothing older than the run itself
|
|
1027
1030
|
- Subsequent runs use this timestamp as the starting point
|
|
1028
1031
|
|
|
1029
1032
|
3. Error handling and recovery:
|
|
@@ -1245,9 +1248,9 @@ components:
|
|
|
1245
1248
|
- 'null'
|
|
1246
1249
|
format: date-time
|
|
1247
1250
|
description: |-
|
|
1248
|
-
|
|
1249
|
-
|
|
1250
|
-
|
|
1251
|
+
Lower-bound cutoff for the first run. Omitting it doesn't export history: the first run
|
|
1252
|
+
then starts at its own timestamp. Set it to the earliest change the first run should pick
|
|
1253
|
+
up. Subsequent runs use the platform-managed last-successful-run timestamp.
|
|
1251
1254
|
x-celigo-ai-guidance:
|
|
1252
1255
|
- |-
|
|
1253
1256
|
Initial cutoff timestamp for the first export run, in ISO-8601 UTC format (e.g.
|
package/dist/flow.yml
CHANGED
|
@@ -824,8 +824,9 @@ paths:
|
|
|
824
824
|
|
|
825
825
|
The request body is optional. When omitted, the flow runs with its configured schedule behavior —
|
|
826
826
|
for delta flows this means using the current `lastExportDateTime` as the lower bound. Pass
|
|
827
|
-
`export.startDate` / `export.endDate` to
|
|
828
|
-
|
|
827
|
+
`export.startDate` / `export.endDate` to set this run's delta window. On success, when
|
|
828
|
+
`export.endDate` is sent, the flow's checkpoint is left at that value, so an end date in the past
|
|
829
|
+
moves the next run's lower bound back. Pass `_exportIds` to limit execution to a subset of the flow's
|
|
829
830
|
generators (useful for flows with many independent sources).
|
|
830
831
|
|
|
831
832
|
Flow-level preconditions enforced by the platform:
|
|
@@ -835,8 +836,9 @@ paths:
|
|
|
835
836
|
|
|
836
837
|
To trace a run end-to-end, arm debug logging before calling this, then use the returned
|
|
837
838
|
`_jobId` with the execution-log endpoints. For delta backfills, prefer passing explicit
|
|
838
|
-
`startDate`/`endDate` over editing the export's `lastExportDateTime
|
|
839
|
-
|
|
839
|
+
`startDate`/`endDate` over editing the export's `lastExportDateTime`, and read the checkpoint
|
|
840
|
+
first (`GET /v1/flows/{_id}/lastExportDateTime`): the override doesn't stay with one run, since
|
|
841
|
+
a successful run that sends `endDate` leaves the checkpoint there. A flow runs one instance at a time: a run requested while another
|
|
840
842
|
instance is queued or running is refused with `409 job_already_queued` ("Another instance
|
|
841
843
|
for this flow is already queued or running"), and a run-next-flow trigger that arrives in
|
|
842
844
|
that state is dropped rather than queued.
|
|
@@ -1080,11 +1082,14 @@ paths:
|
|
|
1080
1082
|
generators (exports) in the flow. This value is what gets substituted into the `{{lastExportDateTime}}`
|
|
1081
1083
|
Handlebars variable on the next delta run of any export in the flow.
|
|
1082
1084
|
|
|
1083
|
-
The checkpoint advances automatically at the end of a successful delta run.
|
|
1084
|
-
|
|
1085
|
+
The checkpoint advances automatically at the end of a successful delta run. On success, when
|
|
1086
|
+
`POST /v1/flows/{_id}/run` sends `export.endDate`, the checkpoint is left at that value, so an end
|
|
1087
|
+
date in the past moves the next run's lower bound back.
|
|
1085
1088
|
|
|
1086
|
-
A missing
|
|
1087
|
-
|
|
1089
|
+
A missing value (`null`, a flow that has never run) is not a full re-scan: the next delta run's
|
|
1090
|
+
`{{lastExportDateTime}}` is the export's `delta.startDate` when set, and otherwise the run's own
|
|
1091
|
+
timestamp, which picks up no earlier changes. A very old value re-reads everything changed since
|
|
1092
|
+
then. This is the flow-scoped checkpoint; per-export checkpoints (for flows with multiple
|
|
1088
1093
|
generators that advance independently) are exposed on the export record's `delta` block.
|
|
1089
1094
|
parameters:
|
|
1090
1095
|
- name: _id
|
package/dist/tool.yml
CHANGED
|
@@ -25833,10 +25833,13 @@ components:
|
|
|
25833
25833
|
description: |-
|
|
25834
25834
|
Configures incremental exports that retrieve only records created or modified since the last
|
|
25835
25835
|
successful run. Required when the export's type is "delta"; omit for other export types.
|
|
25836
|
-
|
|
25837
|
-
|
|
25838
|
-
|
|
25839
|
-
|
|
25836
|
+
The platform-managed last-successful-run timestamp (exposed as {{lastExportDateTime}}) is the
|
|
25837
|
+
lower bound, and after a failed run the next run reuses the last successful timestamp so
|
|
25838
|
+
changed records are not missed. A first run is not a full export: with no `startDate`, its
|
|
25839
|
+
{{lastExportDateTime}} is the run's own timestamp (the value {{currentExportDateTime}} also
|
|
25840
|
+
holds), so it picks up no earlier changes. Set `startDate` to reach back further. On success,
|
|
25841
|
+
when `POST /v1/flows/{_id}/run` sends `export.endDate`, the flow's checkpoint is left at that
|
|
25842
|
+
value, so an end date in the past moves the next run's lower bound back.
|
|
25840
25843
|
x-celigo-ai-guidance:
|
|
25841
25844
|
- |-
|
|
25842
25845
|
This object is REQUIRED when the export's type field is set to "delta" and
|
|
@@ -25872,7 +25875,7 @@ components:
|
|
|
25872
25875
|
|
|
25873
25876
|
2. The system automatically maintains the last successful run timestamp
|
|
25874
25877
|
- No need to store or manage timestamps in your own code
|
|
25875
|
-
-
|
|
25878
|
+
- A first run without ``startDate`` fetches nothing older than the run itself
|
|
25876
25879
|
- Subsequent runs use this timestamp as the starting point
|
|
25877
25880
|
|
|
25878
25881
|
3. Error handling and recovery:
|
|
@@ -26094,9 +26097,9 @@ components:
|
|
|
26094
26097
|
- 'null'
|
|
26095
26098
|
format: date-time
|
|
26096
26099
|
description: |-
|
|
26097
|
-
|
|
26098
|
-
|
|
26099
|
-
|
|
26100
|
+
Lower-bound cutoff for the first run. Omitting it doesn't export history: the first run
|
|
26101
|
+
then starts at its own timestamp. Set it to the earliest change the first run should pick
|
|
26102
|
+
up. Subsequent runs use the platform-managed last-successful-run timestamp.
|
|
26100
26103
|
x-celigo-ai-guidance:
|
|
26101
26104
|
- |-
|
|
26102
26105
|
Initial cutoff timestamp for the first export run, in ISO-8601 UTC format (e.g.
|
package/package.json
CHANGED