@celigo/api-specs 0.2.189 → 0.2.190

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 CHANGED
@@ -995,10 +995,12 @@ components:
995
995
  Configures incremental exports that retrieve only records created or modified since the
996
996
  flow's delta checkpoint; omit it for other export types. Adaptors that compare a record field
997
997
  name it in `dateField`, while HTTP exports and SQL queries carry {{lastExportDateTime}} in the
998
- request and save without a delta object. Each run's window runs from {{lastExportDateTime}}
999
- (the checkpoint) to {{currentExportDateTime}} (the time the run started). A first run is not a
1000
- full export: with no `startDate`, its {{lastExportDateTime}} is the run's own timestamp, so it
1001
- picks up no earlier changes. The checkpoint moves to a run's window end only when the run
998
+ request and save without a delta object. Each run reads the window from {{lastExportDateTime}}
999
+ to {{currentExportDateTime}}: the flow's checkpoint and the time the run started, both less
1000
+ `lagOffset` when it is set. Until a run has exported records the flow has no checkpoint, and
1001
+ {{lastExportDateTime}} is `startDate` itself, unshifted. A first run is not a full export: with
1002
+ no `startDate`, its {{lastExportDateTime}} is the run's own timestamp, so it picks up no
1003
+ earlier changes. The checkpoint moves to a run's start time only when the run
1002
1004
  exports records, so a run that exports nothing leaves it where it was, and after a failed run
1003
1005
  the next run reuses the last checkpoint. On success, when `POST /v1/flows/{_id}/run` sends
1004
1006
  `export.endDate`, the flow's checkpoint is left at that value, so an end date in the past
@@ -1025,7 +1027,7 @@ components:
1025
1027
  default ``startDate`` to **today at midnight UTC** in ISO-8601 format
1026
1028
  (e.g. ``"2026-05-14T00:00:00.000Z"``). This means the first run picks
1027
1029
  up records changed today; subsequent runs use the platform-managed
1028
- ``{{lastExportDateTime}}`` (the end of the last run that exported records).
1030
+ ``{{lastExportDateTime}}`` (the start of the last run that exported records, less ``lagOffset``).
1029
1031
 
1030
1032
  - First run: filters records changed since ``startDate``.
1031
1033
  - Subsequent runs: uses ``{{lastExportDateTime}}`` as the lower bound;
@@ -1041,10 +1043,13 @@ components:
1041
1043
  2. The system automatically maintains the checkpoint
1042
1044
  - No need to store or manage timestamps in your own code
1043
1045
  - A first run without ``startDate`` fetches nothing older than the run itself
1044
- - A run that exports records moves the checkpoint to its window end
1045
- ({{currentExportDateTime}}), where the next run starts
1046
- - Use {{lastExportDateTime}} as the lower bound; {{currentExportDateTime}} as the
1047
- lower bound asks for records changed after the run started, so every run exports nothing
1046
+ - A run that exports records moves the checkpoint to its start time. The next run
1047
+ reads from the checkpoint less ``lagOffset``, which is this run's
1048
+ {{currentExportDateTime}} while ``lagOffset`` is unchanged
1049
+ - Use {{lastExportDateTime}} as the lower bound. {{currentExportDateTime}} as the
1050
+ lower bound asks only for records changed after this run's start less ``lagOffset``
1051
+ (nothing when it is 0), so the changes from {{lastExportDateTime}} up to that bound are
1052
+ never exported
1048
1053
 
1049
1054
  3. Error handling and recovery:
1050
1055
  - If an export fails, the next run uses the last successful timestamp
@@ -1055,7 +1060,7 @@ components:
1055
1060
  - A run given its own window (export.startDate / export.endDate on
1056
1061
  POST /v1/flows/{_id}/run) that exports records leaves the checkpoint at endDate,
1057
1062
  even a past one, so the next run re-reads everything after it
1058
- - The lagOffset field can be used to handle edge cases
1063
+ - ``lagOffset`` delays every window by its value, for a source that shows changes late
1059
1064
  - |-
1060
1065
  Omit this object for export types other than "delta". An HTTP export with type
1061
1066
  "delta" saves without it, since the request carries {{lastExportDateTime}}, but
@@ -1225,46 +1230,36 @@ components:
1225
1230
  lagOffset:
1226
1231
  type: integer
1227
1232
  description: |-
1228
- Buffer in milliseconds subtracted from the last successful run timestamp, creating an
1229
- overlapping window that catches records still propagating when the previous run executed.
1230
- Set it when records created or modified near the run time are occasionally skipped due to
1231
- replication or indexing delays. Keep it as low as possible — larger values reprocess
1232
- redundant records. A negative value shifts the window forward (look-ahead) instead of back.
1233
+ Milliseconds taken off a run's start time to give `{{currentExportDateTime}}`, the window's
1234
+ upper bound, and off the flow's checkpoint, the start time of the last run that exported
1235
+ records, to give `{{lastExportDateTime}}`, its lower bound. Until a run has exported records
1236
+ there is no checkpoint, and the lower bound is `startDate` itself, unshifted, so a
1237
+ `startDate` within the last `lagOffset` gives the run an empty window. While the value stays the same, windows stay back to back and nothing is read twice:
1238
+ each record just reaches a run `lagOffset` later, after it has had that long to become
1239
+ visible. Changing it moves the next window's start by the change: raising it re-reads the
1240
+ added span once, and lowering it skips the removed span. Set it when records
1241
+ changed shortly before a run are sometimes missing because the source shows them with a
1242
+ delay (indexing, replication), and keep it no larger than that delay, since every record
1243
+ waits that much longer. Never set a negative value: once the flow has a checkpoint it moves
1244
+ both ends into the future, so a record changed in the `lagOffset` after each run falls in no
1245
+ window and is never exported (before a checkpoint only `{{currentExportDateTime}}` moves).
1233
1246
  x-celigo-ai-guidance:
1234
- - Specifies a time buffer (in milliseconds) to account for system data propagation delays.
1235
1247
  - |-
1236
- ## FIELD BEHAVIOR
1237
-
1238
- This field addresses synchronization issues caused by replication or indexing delays:
1239
-
1240
- - OPTIONAL: Only needed for systems with known data visibility delays
1241
- - Value is SUBTRACTED from the last successful run timestamp
1242
- - Creates an overlapping window to catch records that were being processed
1243
- during the previous export
1244
- - Measured in milliseconds (1000ms = 1 second)
1245
- - |-
1246
- ## IMPLEMENTATION PATTERN
1247
-
1248
- The formula for the effective filter date is:
1249
- ```
1250
- effectiveFilterDate = lastSuccessfulRunTime - lagOffset
1251
- ```
1252
- - |-
1253
- ## COMMON VALUES
1254
-
1255
- - 15000 (15 seconds): Typical for systems with short indexing delays
1256
- - 60000 (1 minute): Common for systems with moderate replication lag
1257
- - 300000 (5 minutes): For systems with significant processing delays
1248
+ Verified live (2026-10-23, an HTTP delta export run twice with `lagOffset` 3600000 and
1249
+ then twice with -3600000): each run's `{{currentExportDateTime}}` was its start minus
1250
+ `lagOffset`; the next run's `{{lastExportDateTime}}` was the previous run's start minus
1251
+ `lagOffset`, which equals the previous `{{currentExportDateTime}}` while the value is
1252
+ unchanged; the first successful run's `{{lastExportDateTime}}` was `startDate` unshifted,
1253
+ after two failed runs that hadn't moved it. With -3600000 both ends were an hour after
1254
+ the run, and the switch from 3600000 moved the next window's start two hours past the
1255
+ previous `{{currentExportDateTime}}`, skipping that span.
1258
1256
  - |-
1259
1257
  ## DIAGNOSIS
1260
1258
 
1261
- This field should be configured when you observe:
1262
- - Records occasionally missing from delta exports
1263
- - Records created/modified near the export run time being skipped
1264
- - Inconsistent results between runs with similar data changes
1265
-
1266
- IMPORTANT: Setting this value too high decreases efficiency by processing
1267
- redundant records. Set only as high as needed to avoid missed records.
1259
+ Set it when records created or modified near the run time are occasionally missing from
1260
+ a delta export because the source makes them visible late. Start from the observed delay
1261
+ (15000 to 300000 is typical) and raise it only as far as the misses stop: each record
1262
+ arrives `lagOffset` later, and each raise re-reads the added span once.
1268
1263
  examples:
1269
1264
  - 15000
1270
1265
  - 30000
@@ -1275,10 +1270,10 @@ components:
1275
1270
  - 'null'
1276
1271
  format: date-time
1277
1272
  description: |-
1278
- Lower-bound cutoff for the first run. Omitting it doesn't export history: the first run
1273
+ Lower-bound cutoff for the first run, and for every run until one exports records. Omitting it doesn't export history: the first run
1279
1274
  then starts at its own timestamp, an empty window. Set it to the earliest change the first
1280
- run should pick up. Later runs start from the flow's checkpoint, the end of the last run
1281
- that exported records.
1275
+ run should pick up. Later runs start from the flow's checkpoint, the start of the last run
1276
+ that exported records (less `lagOffset`).
1282
1277
  x-celigo-ai-guidance:
1283
1278
  - |-
1284
1279
  Initial cutoff timestamp for the first export run, in ISO-8601 UTC format (e.g.
@@ -1297,8 +1292,8 @@ components:
1297
1292
  - |-
1298
1293
  ## SUBSEQUENT RUNS
1299
1294
  After the first run that exports records, the platform keeps the
1300
- flow's checkpoint at the end of the last run that exported records
1301
- and exposes it as ``{{lastExportDateTime}}``; runs that export
1295
+ flow's checkpoint at the start of the last run that exported records
1296
+ and exposes it, less ``lagOffset``, as ``{{lastExportDateTime}}``; runs that export
1302
1297
  nothing leave it unchanged. ``startDate`` becomes the floor used
1303
1298
  only when the platform timestamp is absent (e.g. after a reset).
1304
1299
  - |-
package/dist/flow.yml CHANGED
@@ -5115,7 +5115,7 @@ components:
5115
5115
  description: Overrides the fixed start timestamp used for the delta window on the abstract flow's export, in place of the last successful run time.
5116
5116
  lagOffset:
5117
5117
  type: integer
5118
- description: Overrides the buffer in milliseconds subtracted from the last successful run timestamp, creating an overlapping window that catches late-propagating records.
5118
+ description: Overrides the abstract flow's export `delta.lagOffset` -- milliseconds taken off both ends of a delta window once the flow has a checkpoint, so records reach a run that much later. While the value stays the same, windows don't overlap; raising it re-reads the added span once, and lowering it skips the removed span. Never negative (once the flow has a checkpoint, that moves the window into the future and skips records).
5119
5119
  endDateField:
5120
5120
  type: string
5121
5121
  description: Overrides the record timestamp field used as the upper bound of the delta window on the abstract flow's export.
package/dist/tool.yml CHANGED
@@ -26745,10 +26745,12 @@ components:
26745
26745
  Configures incremental exports that retrieve only records created or modified since the
26746
26746
  flow's delta checkpoint; omit it for other export types. Adaptors that compare a record field
26747
26747
  name it in `dateField`, while HTTP exports and SQL queries carry {{lastExportDateTime}} in the
26748
- request and save without a delta object. Each run's window runs from {{lastExportDateTime}}
26749
- (the checkpoint) to {{currentExportDateTime}} (the time the run started). A first run is not a
26750
- full export: with no `startDate`, its {{lastExportDateTime}} is the run's own timestamp, so it
26751
- picks up no earlier changes. The checkpoint moves to a run's window end only when the run
26748
+ request and save without a delta object. Each run reads the window from {{lastExportDateTime}}
26749
+ to {{currentExportDateTime}}: the flow's checkpoint and the time the run started, both less
26750
+ `lagOffset` when it is set. Until a run has exported records the flow has no checkpoint, and
26751
+ {{lastExportDateTime}} is `startDate` itself, unshifted. A first run is not a full export: with
26752
+ no `startDate`, its {{lastExportDateTime}} is the run's own timestamp, so it picks up no
26753
+ earlier changes. The checkpoint moves to a run's start time only when the run
26752
26754
  exports records, so a run that exports nothing leaves it where it was, and after a failed run
26753
26755
  the next run reuses the last checkpoint. On success, when `POST /v1/flows/{_id}/run` sends
26754
26756
  `export.endDate`, the flow's checkpoint is left at that value, so an end date in the past
@@ -26775,7 +26777,7 @@ components:
26775
26777
  default ``startDate`` to **today at midnight UTC** in ISO-8601 format
26776
26778
  (e.g. ``"2026-05-14T00:00:00.000Z"``). This means the first run picks
26777
26779
  up records changed today; subsequent runs use the platform-managed
26778
- ``{{lastExportDateTime}}`` (the end of the last run that exported records).
26780
+ ``{{lastExportDateTime}}`` (the start of the last run that exported records, less ``lagOffset``).
26779
26781
 
26780
26782
  - First run: filters records changed since ``startDate``.
26781
26783
  - Subsequent runs: uses ``{{lastExportDateTime}}`` as the lower bound;
@@ -26791,10 +26793,13 @@ components:
26791
26793
  2. The system automatically maintains the checkpoint
26792
26794
  - No need to store or manage timestamps in your own code
26793
26795
  - A first run without ``startDate`` fetches nothing older than the run itself
26794
- - A run that exports records moves the checkpoint to its window end
26795
- ({{currentExportDateTime}}), where the next run starts
26796
- - Use {{lastExportDateTime}} as the lower bound; {{currentExportDateTime}} as the
26797
- lower bound asks for records changed after the run started, so every run exports nothing
26796
+ - A run that exports records moves the checkpoint to its start time. The next run
26797
+ reads from the checkpoint less ``lagOffset``, which is this run's
26798
+ {{currentExportDateTime}} while ``lagOffset`` is unchanged
26799
+ - Use {{lastExportDateTime}} as the lower bound. {{currentExportDateTime}} as the
26800
+ lower bound asks only for records changed after this run's start less ``lagOffset``
26801
+ (nothing when it is 0), so the changes from {{lastExportDateTime}} up to that bound are
26802
+ never exported
26798
26803
 
26799
26804
  3. Error handling and recovery:
26800
26805
  - If an export fails, the next run uses the last successful timestamp
@@ -26805,7 +26810,7 @@ components:
26805
26810
  - A run given its own window (export.startDate / export.endDate on
26806
26811
  POST /v1/flows/{_id}/run) that exports records leaves the checkpoint at endDate,
26807
26812
  even a past one, so the next run re-reads everything after it
26808
- - The lagOffset field can be used to handle edge cases
26813
+ - ``lagOffset`` delays every window by its value, for a source that shows changes late
26809
26814
  - |-
26810
26815
  Omit this object for export types other than "delta". An HTTP export with type
26811
26816
  "delta" saves without it, since the request carries {{lastExportDateTime}}, but
@@ -26975,46 +26980,36 @@ components:
26975
26980
  lagOffset:
26976
26981
  type: integer
26977
26982
  description: |-
26978
- Buffer in milliseconds subtracted from the last successful run timestamp, creating an
26979
- overlapping window that catches records still propagating when the previous run executed.
26980
- Set it when records created or modified near the run time are occasionally skipped due to
26981
- replication or indexing delays. Keep it as low as possible — larger values reprocess
26982
- redundant records. A negative value shifts the window forward (look-ahead) instead of back.
26983
- x-celigo-ai-guidance:
26984
- - Specifies a time buffer (in milliseconds) to account for system data propagation delays.
26985
- - |-
26986
- ## FIELD BEHAVIOR
26987
-
26988
- This field addresses synchronization issues caused by replication or indexing delays:
26989
-
26990
- - OPTIONAL: Only needed for systems with known data visibility delays
26991
- - Value is SUBTRACTED from the last successful run timestamp
26992
- - Creates an overlapping window to catch records that were being processed
26993
- during the previous export
26994
- - Measured in milliseconds (1000ms = 1 second)
26995
- - |-
26996
- ## IMPLEMENTATION PATTERN
26997
-
26998
- The formula for the effective filter date is:
26999
- ```
27000
- effectiveFilterDate = lastSuccessfulRunTime - lagOffset
27001
- ```
27002
- - |-
27003
- ## COMMON VALUES
27004
-
27005
- - 15000 (15 seconds): Typical for systems with short indexing delays
27006
- - 60000 (1 minute): Common for systems with moderate replication lag
27007
- - 300000 (5 minutes): For systems with significant processing delays
26983
+ Milliseconds taken off a run's start time to give `{{currentExportDateTime}}`, the window's
26984
+ upper bound, and off the flow's checkpoint, the start time of the last run that exported
26985
+ records, to give `{{lastExportDateTime}}`, its lower bound. Until a run has exported records
26986
+ there is no checkpoint, and the lower bound is `startDate` itself, unshifted, so a
26987
+ `startDate` within the last `lagOffset` gives the run an empty window. While the value stays the same, windows stay back to back and nothing is read twice:
26988
+ each record just reaches a run `lagOffset` later, after it has had that long to become
26989
+ visible. Changing it moves the next window's start by the change: raising it re-reads the
26990
+ added span once, and lowering it skips the removed span. Set it when records
26991
+ changed shortly before a run are sometimes missing because the source shows them with a
26992
+ delay (indexing, replication), and keep it no larger than that delay, since every record
26993
+ waits that much longer. Never set a negative value: once the flow has a checkpoint it moves
26994
+ both ends into the future, so a record changed in the `lagOffset` after each run falls in no
26995
+ window and is never exported (before a checkpoint only `{{currentExportDateTime}}` moves).
26996
+ x-celigo-ai-guidance:
26997
+ - |-
26998
+ Verified live (2026-10-23, an HTTP delta export run twice with `lagOffset` 3600000 and
26999
+ then twice with -3600000): each run's `{{currentExportDateTime}}` was its start minus
27000
+ `lagOffset`; the next run's `{{lastExportDateTime}}` was the previous run's start minus
27001
+ `lagOffset`, which equals the previous `{{currentExportDateTime}}` while the value is
27002
+ unchanged; the first successful run's `{{lastExportDateTime}}` was `startDate` unshifted,
27003
+ after two failed runs that hadn't moved it. With -3600000 both ends were an hour after
27004
+ the run, and the switch from 3600000 moved the next window's start two hours past the
27005
+ previous `{{currentExportDateTime}}`, skipping that span.
27008
27006
  - |-
27009
27007
  ## DIAGNOSIS
27010
27008
 
27011
- This field should be configured when you observe:
27012
- - Records occasionally missing from delta exports
27013
- - Records created/modified near the export run time being skipped
27014
- - Inconsistent results between runs with similar data changes
27015
-
27016
- IMPORTANT: Setting this value too high decreases efficiency by processing
27017
- redundant records. Set only as high as needed to avoid missed records.
27009
+ Set it when records created or modified near the run time are occasionally missing from
27010
+ a delta export because the source makes them visible late. Start from the observed delay
27011
+ (15000 to 300000 is typical) and raise it only as far as the misses stop: each record
27012
+ arrives `lagOffset` later, and each raise re-reads the added span once.
27018
27013
  examples:
27019
27014
  - 15000
27020
27015
  - 30000
@@ -27025,10 +27020,10 @@ components:
27025
27020
  - 'null'
27026
27021
  format: date-time
27027
27022
  description: |-
27028
- Lower-bound cutoff for the first run. Omitting it doesn't export history: the first run
27023
+ Lower-bound cutoff for the first run, and for every run until one exports records. Omitting it doesn't export history: the first run
27029
27024
  then starts at its own timestamp, an empty window. Set it to the earliest change the first
27030
- run should pick up. Later runs start from the flow's checkpoint, the end of the last run
27031
- that exported records.
27025
+ run should pick up. Later runs start from the flow's checkpoint, the start of the last run
27026
+ that exported records (less `lagOffset`).
27032
27027
  x-celigo-ai-guidance:
27033
27028
  - |-
27034
27029
  Initial cutoff timestamp for the first export run, in ISO-8601 UTC format (e.g.
@@ -27047,8 +27042,8 @@ components:
27047
27042
  - |-
27048
27043
  ## SUBSEQUENT RUNS
27049
27044
  After the first run that exports records, the platform keeps the
27050
- flow's checkpoint at the end of the last run that exported records
27051
- and exposes it as ``{{lastExportDateTime}}``; runs that export
27045
+ flow's checkpoint at the start of the last run that exported records
27046
+ and exposes it, less ``lagOffset``, as ``{{lastExportDateTime}}``; runs that export
27052
27047
  nothing leave it unchanged. ``startDate`` becomes the floor used
27053
27048
  only when the platform timestamp is absent (e.g. after a reset).
27054
27049
  - |-
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@celigo/api-specs",
3
- "version": "0.2.189",
3
+ "version": "0.2.190",
4
4
  "private": false,
5
5
  "description": "Public OpenAPI bundles (dist/) and the celigo-cli lint schema pack (schemas.json).",
6
6
  "keywords": [
package/schemas.json CHANGED
@@ -1,8 +1,8 @@
1
1
  {
2
2
  "provenance": {
3
3
  "repo": "celigo/integrator-api-specs",
4
- "iasCommit": "d34fe6f2",
5
- "generatedAt": "2026-10-23"
4
+ "iasCommit": "c801232e",
5
+ "generatedAt": "2026-10-25"
6
6
  },
7
7
  "roots": {
8
8
  "aiagent": 128,