@celigo/api-specs 0.2.148 → 0.2.149
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 +5 -2
- package/dist/flow.yml +40 -6
- package/dist/import.yml +12 -3
- package/dist/tool.yml +17 -5
- package/package.json +1 -1
- package/schemas.json +1 -1
package/dist/export.yml
CHANGED
|
@@ -16405,8 +16405,11 @@ components:
|
|
|
16405
16405
|
filter, before the page is sent to downstream steps; commonly used to flatten
|
|
16406
16406
|
structures, drop unwanted records, or add computed fields. It receives the page as
|
|
16407
16407
|
`options.data` (with `errors`, `pageIndex`, `configuration` and `settings`) and returns
|
|
16408
|
-
`{data, errors, abort, newErrorsAndRetryData}`.
|
|
16409
|
-
|
|
16408
|
+
`{data, errors, abort, newErrorsAndRetryData}`. Return that object, not the array: a
|
|
16409
|
+
hook that returns `options.data` itself, or a filtered copy, drops the page without an
|
|
16410
|
+
error, and the run completes with 0 records, 0 errors and 0 pages. An exception thrown
|
|
16411
|
+
here fails every record on that page, each with its own retry data, and later pages
|
|
16412
|
+
still run.
|
|
16410
16413
|
properties:
|
|
16411
16414
|
function:
|
|
16412
16415
|
type: string
|
package/dist/flow.yml
CHANGED
|
@@ -4226,7 +4226,10 @@ components:
|
|
|
4226
4226
|
type: string
|
|
4227
4227
|
description: |-
|
|
4228
4228
|
Cron expression for this specific generator, overriding the flow's main schedule.
|
|
4229
|
-
When omitted, the generator inherits the flow's schedule.
|
|
4229
|
+
When omitted, the generator inherits the flow's schedule. It is read in the flow's
|
|
4230
|
+
`timezone`, and a flow with no flow-level `schedule` still runs on it. PATCH reaches
|
|
4231
|
+
the flow-level `/schedule` and `/timezone` but not this field, so changing it is a full
|
|
4232
|
+
update of the flow.
|
|
4230
4233
|
examples:
|
|
4231
4234
|
- '? 5 0,6,12,18 ? * *'
|
|
4232
4235
|
- '? 30 2 ? * *'
|
|
@@ -4236,6 +4239,10 @@ components:
|
|
|
4236
4239
|
- Overrides the flow's main schedule for this generator
|
|
4237
4240
|
- Allows different data sources to refresh at different intervals
|
|
4238
4241
|
- Useful for sources with varying update frequencies
|
|
4242
|
+
- |-
|
|
4243
|
+
Check for one before rescheduling a flow: a flow-level `schedule` change succeeds
|
|
4244
|
+
but leaves a generator that has its own `schedule` running at its old times. Change
|
|
4245
|
+
the generator's `schedule` instead, with a PUT of the whole flow.
|
|
4239
4246
|
skipRetries:
|
|
4240
4247
|
type: boolean
|
|
4241
4248
|
default: false
|
|
@@ -4650,7 +4657,16 @@ components:
|
|
|
4650
4657
|
Filter criteria that determines which records match this branch.
|
|
4651
4658
|
|
|
4652
4659
|
Only used when the router's `routeRecordsUsing` is `input_filters`.
|
|
4653
|
-
Records matching these criteria will be routed to this branch.
|
|
4660
|
+
Records matching these criteria will be routed to this branch. A branch
|
|
4661
|
+
without an `inputFilter` matches every record, so under
|
|
4662
|
+
`first_matching_branch` the catch-all branch goes last.
|
|
4663
|
+
|
|
4664
|
+
Send `version` and `rules` directly on `inputFilter` — not inside the
|
|
4665
|
+
`{type: "expression", expression: {...}}` wrapper that export and import
|
|
4666
|
+
filters use. A wrapped filter is saved without an error, but the branch is
|
|
4667
|
+
stored with no `inputFilter` and takes every record.
|
|
4668
|
+
x-celigo-ai-guidance:
|
|
4669
|
+
- Read the flow back after saving a branching router and check that each filtered branch still has its `inputFilter`; a filter sent in the export-filter wrapper is dropped on save without an error.
|
|
4654
4670
|
properties:
|
|
4655
4671
|
version:
|
|
4656
4672
|
type: string
|
|
@@ -4679,6 +4695,11 @@ components:
|
|
|
4679
4695
|
logical operators (`and`, `or`, `not`), field access (`extract`, `settings`)
|
|
4680
4696
|
and type conversions (`string`, `number`, `boolean`, `epochtime`).
|
|
4681
4697
|
|
|
4698
|
+
Every `extract` must be wrapped in a type conversion. A bare
|
|
4699
|
+
`["extract", "<field>"]` is refused when the flow is saved, with 422 "Field
|
|
4700
|
+
operation extract must be called by a Type Conversion Operation but was called
|
|
4701
|
+
by equals." (the message names the operator that held it).
|
|
4702
|
+
|
|
4682
4703
|
Example — route records whose `isDeleted` field is the string "false":
|
|
4683
4704
|
```json
|
|
4684
4705
|
["equals", ["string", ["extract", "isDeleted"]], "false"]
|
|
@@ -4782,7 +4803,7 @@ components:
|
|
|
4782
4803
|
examples:
|
|
4783
4804
|
- first_matching_branch
|
|
4784
4805
|
x-celigo-ai-guidance:
|
|
4785
|
-
- Set this and `routeRecordsUsing` together on every router that decides between branches; setting only one of the two is rejected with 422 `invalid_flow_router_config
|
|
4806
|
+
- Set this and `routeRecordsUsing` together on every router that decides between branches; setting only one of the two is rejected with 422 `invalid_flow_router_config` ("Either both the routeRecordsTo and routeRecordsUsing fields or none of them should be defined on the router.").
|
|
4786
4807
|
- Leave both unset on a one-branch pass-through router (the steps before the first branching router, or a merge point). Setting them there still runs, but Flow Builder shows a router node with one branch and no rules. A router with neither field and more than one branch is rejected with 422 `invalid_flow_router_branch`.
|
|
4787
4808
|
routeRecordsUsing:
|
|
4788
4809
|
type: string
|
|
@@ -5432,7 +5453,9 @@ components:
|
|
|
5432
5453
|
Writable flow fields shared by the request and response schemas.
|
|
5433
5454
|
|
|
5434
5455
|
Use `pageProcessors` for simple linear flows or `routers` for conditional branching — never
|
|
5435
|
-
include both: a flow with both arrays non-empty is rejected with 422 `invalid_branched_flow_config
|
|
5456
|
+
include both: a flow with both arrays non-empty is rejected with 422 `invalid_branched_flow_config`
|
|
5457
|
+
("Either routers or pageProcessors should be present in the flow configuration and not both.").
|
|
5458
|
+
Turning a linear flow into a branching one moves its top-level steps into the branches.
|
|
5436
5459
|
The same import can be a step only once per flow: a second `pageProcessors` entry with its
|
|
5437
5460
|
`_importId`, in the same array or another branch, fails with 422 `invalid_flow` ("… already
|
|
5438
5461
|
included as a pageProcessor"). The `schedule` field uses Celigo's 6-field cron format (not
|
|
@@ -5491,7 +5514,15 @@ components:
|
|
|
5491
5514
|
Build `schedule` as a Celigo 6-field cron:
|
|
5492
5515
|
`? minute hour day-of-month month day-of-week`.
|
|
5493
5516
|
The seconds field is always `?`; day-of-month is usually `?`, month `*`,
|
|
5494
|
-
and day-of-week `*` (or specific days, 0=Sun..6=Sat
|
|
5517
|
+
and day-of-week `*` (or specific days, 0=Sun..6=Sat — weekdays are `1-5`,
|
|
5518
|
+
`1,2,3,4,5` or `MON-FRI`; `2-6` is Tuesday to Saturday).
|
|
5519
|
+
- |-
|
|
5520
|
+
The hours are read in the flow's `timezone`. Keep a user's local times as
|
|
5521
|
+
they are and set their IANA zone; never convert them to UTC, which is an hour
|
|
5522
|
+
off for half the year in a zone with daylight saving and shifts them twice
|
|
5523
|
+
when paired with the local `timezone`. Before changing when a flow runs, read
|
|
5524
|
+
`pageGenerators[]`: a generator with its own `schedule` keeps it after a
|
|
5525
|
+
flow-level change.
|
|
5495
5526
|
- |-
|
|
5496
5527
|
Disabling a flow does not bypass schedule validation: POST, PUT, and PATCH
|
|
5497
5528
|
all reject free text or a sub-minute expression (`not a cron`, `* * * * * *`)
|
|
@@ -5526,7 +5557,10 @@ components:
|
|
|
5526
5557
|
type:
|
|
5527
5558
|
- string
|
|
5528
5559
|
- 'null'
|
|
5529
|
-
description:
|
|
5560
|
+
description: |-
|
|
5561
|
+
IANA timezone for the schedule (e.g. `America/New_York`). Defaults to UTC. The flow's
|
|
5562
|
+
`schedule` and each page generator's own `schedule` are read in this timezone; a page
|
|
5563
|
+
generator has no timezone of its own.
|
|
5530
5564
|
examples:
|
|
5531
5565
|
- America/New_York
|
|
5532
5566
|
- Europe/London
|
package/dist/import.yml
CHANGED
|
@@ -16408,7 +16408,11 @@ components:
|
|
|
16408
16408
|
- script
|
|
16409
16409
|
description: |-
|
|
16410
16410
|
Hook that runs on each page of records before the import's mappings are applied.
|
|
16411
|
-
Commonly used to reshape or filter records ahead of mapping.
|
|
16411
|
+
Commonly used to reshape or filter records ahead of mapping. Its changes shape only
|
|
16412
|
+
the request this import sends: the next step receives the record as it arrived here,
|
|
16413
|
+
plus whatever this step's response mapping merges back. A value later steps need
|
|
16414
|
+
belongs in the source export's `preSavePage`, in this step's `postResponseMap` hook on
|
|
16415
|
+
the flow, or in the later import's own `preMap`.
|
|
16412
16416
|
x-celigo-ai-guidance:
|
|
16413
16417
|
- |-
|
|
16414
16418
|
Pre-map JavaScript hook — runs once per page BEFORE the
|
|
@@ -16430,7 +16434,8 @@ components:
|
|
|
16430
16434
|
description: |-
|
|
16431
16435
|
Hook that runs after the import's mappings are applied but before records are sent
|
|
16432
16436
|
to the destination system. Commonly used for adjustments that need the mapped
|
|
16433
|
-
(destination-shaped) record.
|
|
16437
|
+
(destination-shaped) record. Like `preMap`, its changes shape only the request this
|
|
16438
|
+
import sends; the next step never sees them.
|
|
16434
16439
|
x-celigo-ai-guidance:
|
|
16435
16440
|
- |-
|
|
16436
16441
|
Post-map JavaScript hook — runs once per page AFTER the
|
|
@@ -16453,7 +16458,11 @@ components:
|
|
|
16453
16458
|
description: |-
|
|
16454
16459
|
Hook that runs after the destination system responds, with access to both the
|
|
16455
16460
|
submitted records and the destination's responses. Commonly used to inspect results
|
|
16456
|
-
or adjust the response data passed downstream.
|
|
16461
|
+
or adjust the response data passed downstream. Each `options.responseData` entry is
|
|
16462
|
+
one submitted record's result, in order: `statusCode`, `errors` (`{code, message,
|
|
16463
|
+
source}`, empty on success), `ignored`, `id`, and `_json` — the destination's parsed
|
|
16464
|
+
response body, where its own error detail sits (`_headers` holds the response
|
|
16465
|
+
headers).
|
|
16457
16466
|
x-celigo-ai-guidance:
|
|
16458
16467
|
- |-
|
|
16459
16468
|
Post-submit JavaScript hook — runs AFTER each batch of
|
package/dist/tool.yml
CHANGED
|
@@ -25289,7 +25289,11 @@ components:
|
|
|
25289
25289
|
- script
|
|
25290
25290
|
description: |-
|
|
25291
25291
|
Hook that runs on each page of records before the import's mappings are applied.
|
|
25292
|
-
Commonly used to reshape or filter records ahead of mapping.
|
|
25292
|
+
Commonly used to reshape or filter records ahead of mapping. Its changes shape only
|
|
25293
|
+
the request this import sends: the next step receives the record as it arrived here,
|
|
25294
|
+
plus whatever this step's response mapping merges back. A value later steps need
|
|
25295
|
+
belongs in the source export's `preSavePage`, in this step's `postResponseMap` hook on
|
|
25296
|
+
the flow, or in the later import's own `preMap`.
|
|
25293
25297
|
x-celigo-ai-guidance:
|
|
25294
25298
|
- |-
|
|
25295
25299
|
Pre-map JavaScript hook — runs once per page BEFORE the
|
|
@@ -25311,7 +25315,8 @@ components:
|
|
|
25311
25315
|
description: |-
|
|
25312
25316
|
Hook that runs after the import's mappings are applied but before records are sent
|
|
25313
25317
|
to the destination system. Commonly used for adjustments that need the mapped
|
|
25314
|
-
(destination-shaped) record.
|
|
25318
|
+
(destination-shaped) record. Like `preMap`, its changes shape only the request this
|
|
25319
|
+
import sends; the next step never sees them.
|
|
25315
25320
|
x-celigo-ai-guidance:
|
|
25316
25321
|
- |-
|
|
25317
25322
|
Post-map JavaScript hook — runs once per page AFTER the
|
|
@@ -25334,7 +25339,11 @@ components:
|
|
|
25334
25339
|
description: |-
|
|
25335
25340
|
Hook that runs after the destination system responds, with access to both the
|
|
25336
25341
|
submitted records and the destination's responses. Commonly used to inspect results
|
|
25337
|
-
or adjust the response data passed downstream.
|
|
25342
|
+
or adjust the response data passed downstream. Each `options.responseData` entry is
|
|
25343
|
+
one submitted record's result, in order: `statusCode`, `errors` (`{code, message,
|
|
25344
|
+
source}`, empty on success), `ignored`, `id`, and `_json` — the destination's parsed
|
|
25345
|
+
response body, where its own error detail sits (`_headers` holds the response
|
|
25346
|
+
headers).
|
|
25338
25347
|
x-celigo-ai-guidance:
|
|
25339
25348
|
- |-
|
|
25340
25349
|
Post-submit JavaScript hook — runs AFTER each batch of
|
|
@@ -37412,8 +37421,11 @@ components:
|
|
|
37412
37421
|
filter, before the page is sent to downstream steps; commonly used to flatten
|
|
37413
37422
|
structures, drop unwanted records, or add computed fields. It receives the page as
|
|
37414
37423
|
`options.data` (with `errors`, `pageIndex`, `configuration` and `settings`) and returns
|
|
37415
|
-
`{data, errors, abort, newErrorsAndRetryData}`.
|
|
37416
|
-
|
|
37424
|
+
`{data, errors, abort, newErrorsAndRetryData}`. Return that object, not the array: a
|
|
37425
|
+
hook that returns `options.data` itself, or a filtered copy, drops the page without an
|
|
37426
|
+
error, and the run completes with 0 records, 0 errors and 0 pages. An exception thrown
|
|
37427
|
+
here fails every record on that page, each with its own retry data, and later pages
|
|
37428
|
+
still run.
|
|
37417
37429
|
properties:
|
|
37418
37430
|
function:
|
|
37419
37431
|
type: string
|
package/package.json
CHANGED