@celigo/api-specs 0.2.21 → 0.2.22
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/ai-agent.yml +21 -2
- package/dist/export.yml +21 -2
- package/dist/import.yml +21 -2
- package/dist/tool.yml +21 -2
- package/package.json +1 -1
- package/schemas.json +1 -1
package/dist/ai-agent.yml
CHANGED
|
@@ -4951,13 +4951,26 @@ components:
|
|
|
4951
4951
|
are re-joined into the record's original shape — the object with its array, or the array of rows —
|
|
4952
4952
|
carrying any response-mapping enrichment, and that re-joined record is what the next step
|
|
4953
4953
|
receives. Not for locating records in an export's HTTP response; use
|
|
4954
|
-
`http.response.resourcePath` for that.
|
|
4954
|
+
`http.response.resourcePath` for that. Applies to steps that receive a record — imports and
|
|
4955
|
+
lookups (an export referenced as a page processor of a flow, API, or Tool). A standalone export
|
|
4956
|
+
(a flow's page generator) has no incoming record, so the fields are saved but have no effect on
|
|
4957
|
+
the records it produces; to emit one record per array element from a standalone export, use a
|
|
4958
|
+
`hooks.preSavePage` script, or for a file-definition export make the repeating segment the
|
|
4959
|
+
record boundary in the definition's rules.
|
|
4955
4960
|
x-celigo-ai-guidance:
|
|
4956
4961
|
- |-
|
|
4957
4962
|
Two modes, decided by the SHAPE of the record entering the step. Object record with a child
|
|
4958
4963
|
array under a field → set ``pathToMany`` to that field. Array record (a ``groupByFields``
|
|
4959
4964
|
export, a CSV/file group, a script that returns an array) → leave ``pathToMany`` blank; each
|
|
4960
4965
|
element becomes one record. Live-verified 2026-09-10 on flows, Tools, and APIs.
|
|
4966
|
+
- |-
|
|
4967
|
+
Only imports and lookups (exports placed as page processors) fan out. On a standalone export
|
|
4968
|
+
(a flow's page generator) the API saves ``oneToMany`` / ``pathToMany`` and applies neither:
|
|
4969
|
+
the records reach the next step unchanged and no error is raised. Live-verified 2026-09-18 on
|
|
4970
|
+
a flow test run — an order record with three ``lines`` reached the import as ONE record with
|
|
4971
|
+
the setting on the export, and as THREE child records with the same setting on the import.
|
|
4972
|
+
Never propose these fields as the way to split a standalone export's records; that is
|
|
4973
|
+
``hooks.preSavePage`` work (or, for a file definition, the definition's record boundary).
|
|
4961
4974
|
- |-
|
|
4962
4975
|
Blank ``pathToMany`` on an OBJECT record fails every record with code ``oneToMany_error``:
|
|
4963
4976
|
"Failed to extract child records from oneToMany import data. Record at index 0 was not an
|
|
@@ -4987,8 +5000,14 @@ components:
|
|
|
4987
5000
|
Path to the array of child records inside an object record when `oneToMany` is true, in dot
|
|
4988
5001
|
notation (`items`, `lines.lineItems`). Leave blank when the incoming record is itself an array
|
|
4989
5002
|
(grouped or row-based data) — each element is then a child record. A path that does not resolve
|
|
4990
|
-
to an array processes zero records and reports success.
|
|
5003
|
+
to an array processes zero records and reports success. Read only on steps that receive a
|
|
5004
|
+
record (imports, lookup exports); on a standalone export it is saved and ignored — see `oneToMany`.
|
|
4991
5005
|
x-celigo-ai-guidance:
|
|
5006
|
+
- |-
|
|
5007
|
+
Inert on a standalone export (a flow's page generator) exactly like ``oneToMany`` — the value
|
|
5008
|
+
is saved, the export's records reach the next step unchanged, and nothing errors
|
|
5009
|
+
(live-verified 2026-09-18). Splitting a standalone export's records into one per element is
|
|
5010
|
+
``hooks.preSavePage`` work, or the file definition's record boundary; never this field.
|
|
4992
5011
|
- |-
|
|
4993
5012
|
Set this ONLY when the record entering the step is an object whose children sit under a field.
|
|
4994
5013
|
On an array record (a ``groupByFields`` export, a CSV/file group, a script returning an array)
|
package/dist/export.yml
CHANGED
|
@@ -803,13 +803,26 @@ components:
|
|
|
803
803
|
are re-joined into the record's original shape — the object with its array, or the array of rows —
|
|
804
804
|
carrying any response-mapping enrichment, and that re-joined record is what the next step
|
|
805
805
|
receives. Not for locating records in an export's HTTP response; use
|
|
806
|
-
`http.response.resourcePath` for that.
|
|
806
|
+
`http.response.resourcePath` for that. Applies to steps that receive a record — imports and
|
|
807
|
+
lookups (an export referenced as a page processor of a flow, API, or Tool). A standalone export
|
|
808
|
+
(a flow's page generator) has no incoming record, so the fields are saved but have no effect on
|
|
809
|
+
the records it produces; to emit one record per array element from a standalone export, use a
|
|
810
|
+
`hooks.preSavePage` script, or for a file-definition export make the repeating segment the
|
|
811
|
+
record boundary in the definition's rules.
|
|
807
812
|
x-celigo-ai-guidance:
|
|
808
813
|
- |-
|
|
809
814
|
Two modes, decided by the SHAPE of the record entering the step. Object record with a child
|
|
810
815
|
array under a field → set ``pathToMany`` to that field. Array record (a ``groupByFields``
|
|
811
816
|
export, a CSV/file group, a script that returns an array) → leave ``pathToMany`` blank; each
|
|
812
817
|
element becomes one record. Live-verified 2026-09-10 on flows, Tools, and APIs.
|
|
818
|
+
- |-
|
|
819
|
+
Only imports and lookups (exports placed as page processors) fan out. On a standalone export
|
|
820
|
+
(a flow's page generator) the API saves ``oneToMany`` / ``pathToMany`` and applies neither:
|
|
821
|
+
the records reach the next step unchanged and no error is raised. Live-verified 2026-09-18 on
|
|
822
|
+
a flow test run — an order record with three ``lines`` reached the import as ONE record with
|
|
823
|
+
the setting on the export, and as THREE child records with the same setting on the import.
|
|
824
|
+
Never propose these fields as the way to split a standalone export's records; that is
|
|
825
|
+
``hooks.preSavePage`` work (or, for a file definition, the definition's record boundary).
|
|
813
826
|
- |-
|
|
814
827
|
Blank ``pathToMany`` on an OBJECT record fails every record with code ``oneToMany_error``:
|
|
815
828
|
"Failed to extract child records from oneToMany import data. Record at index 0 was not an
|
|
@@ -839,8 +852,14 @@ components:
|
|
|
839
852
|
Path to the array of child records inside an object record when `oneToMany` is true, in dot
|
|
840
853
|
notation (`items`, `lines.lineItems`). Leave blank when the incoming record is itself an array
|
|
841
854
|
(grouped or row-based data) — each element is then a child record. A path that does not resolve
|
|
842
|
-
to an array processes zero records and reports success.
|
|
855
|
+
to an array processes zero records and reports success. Read only on steps that receive a
|
|
856
|
+
record (imports, lookup exports); on a standalone export it is saved and ignored — see `oneToMany`.
|
|
843
857
|
x-celigo-ai-guidance:
|
|
858
|
+
- |-
|
|
859
|
+
Inert on a standalone export (a flow's page generator) exactly like ``oneToMany`` — the value
|
|
860
|
+
is saved, the export's records reach the next step unchanged, and nothing errors
|
|
861
|
+
(live-verified 2026-09-18). Splitting a standalone export's records into one per element is
|
|
862
|
+
``hooks.preSavePage`` work, or the file definition's record boundary; never this field.
|
|
844
863
|
- |-
|
|
845
864
|
Set this ONLY when the record entering the step is an object whose children sit under a field.
|
|
846
865
|
On an array record (a ``groupByFields`` export, a CSV/file group, a script returning an array)
|
package/dist/import.yml
CHANGED
|
@@ -10581,13 +10581,26 @@ components:
|
|
|
10581
10581
|
are re-joined into the record's original shape — the object with its array, or the array of rows —
|
|
10582
10582
|
carrying any response-mapping enrichment, and that re-joined record is what the next step
|
|
10583
10583
|
receives. Not for locating records in an export's HTTP response; use
|
|
10584
|
-
`http.response.resourcePath` for that.
|
|
10584
|
+
`http.response.resourcePath` for that. Applies to steps that receive a record — imports and
|
|
10585
|
+
lookups (an export referenced as a page processor of a flow, API, or Tool). A standalone export
|
|
10586
|
+
(a flow's page generator) has no incoming record, so the fields are saved but have no effect on
|
|
10587
|
+
the records it produces; to emit one record per array element from a standalone export, use a
|
|
10588
|
+
`hooks.preSavePage` script, or for a file-definition export make the repeating segment the
|
|
10589
|
+
record boundary in the definition's rules.
|
|
10585
10590
|
x-celigo-ai-guidance:
|
|
10586
10591
|
- |-
|
|
10587
10592
|
Two modes, decided by the SHAPE of the record entering the step. Object record with a child
|
|
10588
10593
|
array under a field → set ``pathToMany`` to that field. Array record (a ``groupByFields``
|
|
10589
10594
|
export, a CSV/file group, a script that returns an array) → leave ``pathToMany`` blank; each
|
|
10590
10595
|
element becomes one record. Live-verified 2026-09-10 on flows, Tools, and APIs.
|
|
10596
|
+
- |-
|
|
10597
|
+
Only imports and lookups (exports placed as page processors) fan out. On a standalone export
|
|
10598
|
+
(a flow's page generator) the API saves ``oneToMany`` / ``pathToMany`` and applies neither:
|
|
10599
|
+
the records reach the next step unchanged and no error is raised. Live-verified 2026-09-18 on
|
|
10600
|
+
a flow test run — an order record with three ``lines`` reached the import as ONE record with
|
|
10601
|
+
the setting on the export, and as THREE child records with the same setting on the import.
|
|
10602
|
+
Never propose these fields as the way to split a standalone export's records; that is
|
|
10603
|
+
``hooks.preSavePage`` work (or, for a file definition, the definition's record boundary).
|
|
10591
10604
|
- |-
|
|
10592
10605
|
Blank ``pathToMany`` on an OBJECT record fails every record with code ``oneToMany_error``:
|
|
10593
10606
|
"Failed to extract child records from oneToMany import data. Record at index 0 was not an
|
|
@@ -10617,8 +10630,14 @@ components:
|
|
|
10617
10630
|
Path to the array of child records inside an object record when `oneToMany` is true, in dot
|
|
10618
10631
|
notation (`items`, `lines.lineItems`). Leave blank when the incoming record is itself an array
|
|
10619
10632
|
(grouped or row-based data) — each element is then a child record. A path that does not resolve
|
|
10620
|
-
to an array processes zero records and reports success.
|
|
10633
|
+
to an array processes zero records and reports success. Read only on steps that receive a
|
|
10634
|
+
record (imports, lookup exports); on a standalone export it is saved and ignored — see `oneToMany`.
|
|
10621
10635
|
x-celigo-ai-guidance:
|
|
10636
|
+
- |-
|
|
10637
|
+
Inert on a standalone export (a flow's page generator) exactly like ``oneToMany`` — the value
|
|
10638
|
+
is saved, the export's records reach the next step unchanged, and nothing errors
|
|
10639
|
+
(live-verified 2026-09-18). Splitting a standalone export's records into one per element is
|
|
10640
|
+
``hooks.preSavePage`` work, or the file definition's record boundary; never this field.
|
|
10622
10641
|
- |-
|
|
10623
10642
|
Set this ONLY when the record entering the step is an object whose children sit under a field.
|
|
10624
10643
|
On an array record (a ``groupByFields`` export, a CSV/file group, a script returning an array)
|
package/dist/tool.yml
CHANGED
|
@@ -19439,13 +19439,26 @@ components:
|
|
|
19439
19439
|
are re-joined into the record's original shape — the object with its array, or the array of rows —
|
|
19440
19440
|
carrying any response-mapping enrichment, and that re-joined record is what the next step
|
|
19441
19441
|
receives. Not for locating records in an export's HTTP response; use
|
|
19442
|
-
`http.response.resourcePath` for that.
|
|
19442
|
+
`http.response.resourcePath` for that. Applies to steps that receive a record — imports and
|
|
19443
|
+
lookups (an export referenced as a page processor of a flow, API, or Tool). A standalone export
|
|
19444
|
+
(a flow's page generator) has no incoming record, so the fields are saved but have no effect on
|
|
19445
|
+
the records it produces; to emit one record per array element from a standalone export, use a
|
|
19446
|
+
`hooks.preSavePage` script, or for a file-definition export make the repeating segment the
|
|
19447
|
+
record boundary in the definition's rules.
|
|
19443
19448
|
x-celigo-ai-guidance:
|
|
19444
19449
|
- |-
|
|
19445
19450
|
Two modes, decided by the SHAPE of the record entering the step. Object record with a child
|
|
19446
19451
|
array under a field → set ``pathToMany`` to that field. Array record (a ``groupByFields``
|
|
19447
19452
|
export, a CSV/file group, a script that returns an array) → leave ``pathToMany`` blank; each
|
|
19448
19453
|
element becomes one record. Live-verified 2026-09-10 on flows, Tools, and APIs.
|
|
19454
|
+
- |-
|
|
19455
|
+
Only imports and lookups (exports placed as page processors) fan out. On a standalone export
|
|
19456
|
+
(a flow's page generator) the API saves ``oneToMany`` / ``pathToMany`` and applies neither:
|
|
19457
|
+
the records reach the next step unchanged and no error is raised. Live-verified 2026-09-18 on
|
|
19458
|
+
a flow test run — an order record with three ``lines`` reached the import as ONE record with
|
|
19459
|
+
the setting on the export, and as THREE child records with the same setting on the import.
|
|
19460
|
+
Never propose these fields as the way to split a standalone export's records; that is
|
|
19461
|
+
``hooks.preSavePage`` work (or, for a file definition, the definition's record boundary).
|
|
19449
19462
|
- |-
|
|
19450
19463
|
Blank ``pathToMany`` on an OBJECT record fails every record with code ``oneToMany_error``:
|
|
19451
19464
|
"Failed to extract child records from oneToMany import data. Record at index 0 was not an
|
|
@@ -19475,8 +19488,14 @@ components:
|
|
|
19475
19488
|
Path to the array of child records inside an object record when `oneToMany` is true, in dot
|
|
19476
19489
|
notation (`items`, `lines.lineItems`). Leave blank when the incoming record is itself an array
|
|
19477
19490
|
(grouped or row-based data) — each element is then a child record. A path that does not resolve
|
|
19478
|
-
to an array processes zero records and reports success.
|
|
19491
|
+
to an array processes zero records and reports success. Read only on steps that receive a
|
|
19492
|
+
record (imports, lookup exports); on a standalone export it is saved and ignored — see `oneToMany`.
|
|
19479
19493
|
x-celigo-ai-guidance:
|
|
19494
|
+
- |-
|
|
19495
|
+
Inert on a standalone export (a flow's page generator) exactly like ``oneToMany`` — the value
|
|
19496
|
+
is saved, the export's records reach the next step unchanged, and nothing errors
|
|
19497
|
+
(live-verified 2026-09-18). Splitting a standalone export's records into one per element is
|
|
19498
|
+
``hooks.preSavePage`` work, or the file definition's record boundary; never this field.
|
|
19480
19499
|
- |-
|
|
19481
19500
|
Set this ONLY when the record entering the step is an object whose children sit under a field.
|
|
19482
19501
|
On an array record (a ``groupByFields`` export, a CSV/file group, a script returning an array)
|
package/package.json
CHANGED