@celigo/api-specs 0.2.190 → 0.2.192
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 +16 -1
- package/dist/export.yml +15 -2
- package/dist/flow.yml +51 -13
- package/dist/job.yml +7 -2
- package/dist/tool.yml +1 -1
- package/package.json +1 -1
- package/schemas.json +1 -1
package/dist/connection.yml
CHANGED
|
@@ -1879,7 +1879,12 @@ paths:
|
|
|
1879
1879
|
searchValue: SEED-01
|
|
1880
1880
|
responses:
|
|
1881
1881
|
'200':
|
|
1882
|
-
description:
|
|
1882
|
+
description: |-
|
|
1883
|
+
The records the source returned, with a per-record link when the adaptor provides one.
|
|
1884
|
+
When paging stopped on a repeated page (observed 2026-10-23), the body was instead
|
|
1885
|
+
`text/plain` holding two JSON objects in a row: the records read, then
|
|
1886
|
+
`{"errors": [...]}` carrying the `page_response_error`. A client that parses that body as
|
|
1887
|
+
one JSON document fails on it; split it into its objects.
|
|
1883
1888
|
content:
|
|
1884
1889
|
application/json:
|
|
1885
1890
|
schema:
|
|
@@ -1912,6 +1917,16 @@ paths:
|
|
|
1912
1917
|
externalid: SEED-01
|
|
1913
1918
|
dataURIs:
|
|
1914
1919
|
- https://1234567.app.netsuite.com/app/common/custom/custrecordentry.nl?rectype=923&id=1
|
|
1920
|
+
text/plain:
|
|
1921
|
+
schema:
|
|
1922
|
+
type: string
|
|
1923
|
+
description: |-
|
|
1924
|
+
Observed only when paging stopped on a repeated page (2026-10-23): two JSON objects
|
|
1925
|
+
in a row, the records read and then the errors.
|
|
1926
|
+
examples:
|
|
1927
|
+
paging_stopped:
|
|
1928
|
+
summary: Paging stopped because a next page repeated the previous one
|
|
1929
|
+
value: '{"data":[{"id":"o-a"},{"id":"o-b"}],"dataURIs":[null,null]}{"errors":[{"code":"page_response_error","message":"Identical response received from next page request. No more page requests will be made.","source":"resource","resolved":false}]}'
|
|
1915
1930
|
'400':
|
|
1916
1931
|
description: The top-level `export` object is missing.
|
|
1917
1932
|
content:
|
package/dist/export.yml
CHANGED
|
@@ -695,7 +695,10 @@ paths:
|
|
|
695
695
|
(after its transform, output filter and preSavePage hook) or an
|
|
696
696
|
`errors` array if the export encountered application-level failures
|
|
697
697
|
(connection timeout, file not found, etc.). Always inspect for errors
|
|
698
|
-
even on 200.
|
|
698
|
+
even on 200. When paging stopped on a repeated page (observed 2026-10-23), the body
|
|
699
|
+
was instead `text/plain` holding two JSON objects in a row: the records read (`data`,
|
|
700
|
+
`dataURIs`), then `{"errors": [...]}` carrying the `page_response_error`. A client that
|
|
701
|
+
parses that body as one JSON document fails on it; split it into its objects.
|
|
699
702
|
content:
|
|
700
703
|
application/json:
|
|
701
704
|
schema:
|
|
@@ -715,6 +718,16 @@ paths:
|
|
|
715
718
|
service: file-adaptor
|
|
716
719
|
resolved: false
|
|
717
720
|
occurredAt: 1777645522601
|
|
721
|
+
text/plain:
|
|
722
|
+
schema:
|
|
723
|
+
type: string
|
|
724
|
+
description: |-
|
|
725
|
+
Observed only when paging stopped on a repeated page (2026-10-23): two JSON objects
|
|
726
|
+
in a row, the records read and then the errors.
|
|
727
|
+
examples:
|
|
728
|
+
paging_stopped:
|
|
729
|
+
summary: Paging stopped because a next page repeated the previous one
|
|
730
|
+
value: '{"data":[{"id":"o-a"},{"id":"o-b"}],"dataURIs":[null,null]}{"errors":[{"code":"page_response_error","message":"Identical response received from next page request. No more page requests will be made.","source":"resource","resolved":false}]}'
|
|
718
731
|
'401':
|
|
719
732
|
$ref: '#/components/responses/401-unauthorized'
|
|
720
733
|
'404':
|
|
@@ -6696,7 +6709,7 @@ components:
|
|
|
6696
6709
|
|
|
6697
6710
|
When this export is the first lookup of a builder-mode API with `pagination.enabled` set, it is that API's volume driver: saving the export (even unchanged) invalidates the API's issued cursors, so a caller mid-walk gets an empty final page, and removing `paging` is accepted on save but makes every call to the API fail with `400 api_pagination_source_not_paged` until paging is restored or the API's flag is turned off.
|
|
6698
6711
|
|
|
6699
|
-
When a next page's response is identical to the previous one, paging stops: the export records an open error with code `page_response_error` ("Identical response received from next page request. No more page requests will be made.") and
|
|
6712
|
+
When a next page's response is identical to the previous one, paging stops: the export records an open error with code `page_response_error` ("Identical response received from next page request. No more page requests will be made.") and later pages are never exported. A request that doesn't change between pages produces this, as observed with `method: page` and the pagination variable missing from the relative URI and body; reference the variable so each request asks for the next page. In that probe (an HTTP export, 2026-10-23) the run completed with the pages already read when the export had no `type`, and failed when it had `type: "delta"`: the steps after the export received nothing and the checkpoint didn't move. Other `type` values weren't tried. An invoke of that export, or a virtual export of the same document, answered 200 with the records read, then `{"errors": [...]}` carrying the `page_response_error`, as two JSON objects in one `text/plain` body.
|
|
6700
6713
|
x-celigo-ai-guidance:
|
|
6701
6714
|
- Configuration object for navigating through multi-page API responses.
|
|
6702
6715
|
- |-
|
package/dist/flow.yml
CHANGED
|
@@ -904,7 +904,22 @@ paths:
|
|
|
904
904
|
'401':
|
|
905
905
|
$ref: '#/components/responses/401-unauthorized'
|
|
906
906
|
'404':
|
|
907
|
-
|
|
907
|
+
description: |-
|
|
908
|
+
Flow not found ("Flow not found"). A flow that exists but has page generators and no step
|
|
909
|
+
after them (no page processor or router) answers the same 404, enabled or disabled
|
|
910
|
+
(observed 2026-10-24), so the answer doesn't tell it from an unknown id: give the flow a
|
|
911
|
+
step after the export before running it. `POST /v1/flows/{_id}/test/run` refuses that flow
|
|
912
|
+
with a 404 of its own wording.
|
|
913
|
+
content:
|
|
914
|
+
application/json:
|
|
915
|
+
schema:
|
|
916
|
+
$ref: '#/components/schemas/Error'
|
|
917
|
+
examples:
|
|
918
|
+
not_found:
|
|
919
|
+
summary: Unknown flow id, or a flow with nothing after its page generators
|
|
920
|
+
value:
|
|
921
|
+
errors:
|
|
922
|
+
- message: Flow not found
|
|
908
923
|
'409':
|
|
909
924
|
description: |-
|
|
910
925
|
Another instance of this flow is already queued or running. Wait for it to
|
|
@@ -2136,12 +2151,17 @@ paths:
|
|
|
2136
2151
|
`pathToMany`, `childIndex`, `traceKey`) identify where in the pipeline the record was when it
|
|
2137
2152
|
failed and how it's structured.
|
|
2138
2153
|
|
|
2139
|
-
The `data` field is the record as
|
|
2140
|
-
|
|
2154
|
+
The `data` field is the record as the failing stage held it: for an import-stage error
|
|
2155
|
+
(`page_processor_import`) on an HTTP import, the record before the import's mappings, not the
|
|
2156
|
+
request the import sent; for a postResponseMap hook's error (`post_response_mapping`), the record
|
|
2157
|
+
after the step's response mapping. Use `PUT .../{retryDataKey}/data` to mutate
|
|
2141
2158
|
the snapshot before retrying. Only errors with a `retryDataKey` expose this endpoint;
|
|
2142
2159
|
connection-class errors are rejected with `no_retrydata_found`. The `stage` field indicates
|
|
2143
|
-
where the retry will resume: `page_processor_import` re-runs the import (most common
|
|
2144
|
-
|
|
2160
|
+
where the retry will resume: `page_processor_import` re-runs the import (most common, and where a
|
|
2161
|
+
postSubmit hook's errors are stored, so their retry writes the records again),
|
|
2162
|
+
`post_response_mapping` (a postResponseMap hook's error) resumes after the import from the stored
|
|
2163
|
+
reply in `adaptorResponse`, sending nothing to the destination again and carrying the record on
|
|
2164
|
+
to the flow's next steps, and `page_generator` means the error was upstream of the processor.
|
|
2145
2165
|
parameters:
|
|
2146
2166
|
- name: _id
|
|
2147
2167
|
in: path
|
|
@@ -7492,14 +7512,19 @@ components:
|
|
|
7492
7512
|
doneExporting:
|
|
7493
7513
|
type: boolean
|
|
7494
7514
|
readOnly: true
|
|
7495
|
-
description:
|
|
7515
|
+
description: |-
|
|
7516
|
+
When true, all export pages have been generated. Observed exception: parent flow jobs
|
|
7517
|
+
read false after their runs completed (runs of an HTTP export into an HTTP import, read
|
|
7518
|
+
again minutes after they ended, 2026-10-23); `status` says whether a run finished.
|
|
7496
7519
|
numPagesProcessed:
|
|
7497
7520
|
type: integer
|
|
7498
7521
|
readOnly: true
|
|
7499
7522
|
description: |-
|
|
7500
7523
|
Number of pages processed by downstream steps: imports and lookup steps. A source export's
|
|
7501
7524
|
child job reads 0, a lookup step's and an import's count the pages they processed, and a
|
|
7502
|
-
parent flow job sums its children.
|
|
7525
|
+
parent flow job sums its children. Observed exception: on those same runs the parent read 0
|
|
7526
|
+
while its import job read 1; when a parent reads 0, read the step jobs
|
|
7527
|
+
(`GET /v1/jobs/{_id}/family`).
|
|
7503
7528
|
examples:
|
|
7504
7529
|
- 10
|
|
7505
7530
|
oIndex:
|
|
@@ -7605,8 +7630,8 @@ components:
|
|
|
7605
7630
|
`GET /v1/flows/{_id}/{_stepId}/{retryDataKey}/data` and accepted (full-replace) by the PUT on the
|
|
7606
7631
|
same path.
|
|
7607
7632
|
|
|
7608
|
-
The `data` field carries the record as it reached the failing
|
|
7609
|
-
that
|
|
7633
|
+
The `data` field carries the record as it reached the failing stage, and a retry resumes from
|
|
7634
|
+
that stage (`stage`) — its shape is adaptor-specific. The surrounding fields identify where in the
|
|
7610
7635
|
pipeline the failure happened and how the record was structured.
|
|
7611
7636
|
properties:
|
|
7612
7637
|
retryDataKey:
|
|
@@ -7616,16 +7641,28 @@ components:
|
|
|
7616
7641
|
- 5f8d43a1b9e5a80011a35f2d-rdk-0
|
|
7617
7642
|
data:
|
|
7618
7643
|
description: |-
|
|
7619
|
-
The record as
|
|
7644
|
+
The record as the failing stage held it, which depends on `stage`. At `page_processor_import`
|
|
7645
|
+
(an import's errors, a postSubmit hook's included) it is the incoming record, before the
|
|
7620
7646
|
import's mappings — not the request body the import sent or the response it got back — and a
|
|
7621
7647
|
retry maps it again with the import's current mappings, so a mapping fix reaches the retried
|
|
7622
|
-
record.
|
|
7648
|
+
record. At `post_response_mapping` (a postResponseMap hook's error) it is the record after the
|
|
7649
|
+
step's response mapping, with the mapped fields: a retry neither maps nor sends it again, and
|
|
7650
|
+
the destination's reply is in `adaptorResponse`. Shape varies by adaptor.
|
|
7623
7651
|
additionalProperties: true
|
|
7624
7652
|
stage:
|
|
7625
7653
|
type: string
|
|
7626
|
-
description:
|
|
7654
|
+
description: |-
|
|
7655
|
+
Pipeline stage where the record was when the error occurred, which is where a retry resumes.
|
|
7656
|
+
`page_processor_import` is the record as it entered the import, so a retry sends it to the
|
|
7657
|
+
destination again; a postSubmit hook's errors are stored here, so retrying them writes records
|
|
7658
|
+
the destination already accepted a second time (live, 2026-10-22). `post_response_mapping` is a
|
|
7659
|
+
postResponseMap hook's error, raised after the destination answered: a retry runs the hook from
|
|
7660
|
+
the stored reply and carries the record on to the flow's next steps, sending nothing to that
|
|
7661
|
+
destination again (live, 2026-10-23 and 2026-10-25: the import's request count didn't change,
|
|
7662
|
+
and the next import received the retried records).
|
|
7627
7663
|
examples:
|
|
7628
7664
|
- page_processor_import
|
|
7665
|
+
- post_response_mapping
|
|
7629
7666
|
- importMappingExtract
|
|
7630
7667
|
pgExportId:
|
|
7631
7668
|
type: string
|
|
@@ -7667,7 +7704,8 @@ components:
|
|
|
7667
7704
|
additionalProperties: true
|
|
7668
7705
|
description: |-
|
|
7669
7706
|
Adaptor-level response envelope captured alongside the record payload. Present on failures
|
|
7670
|
-
returned by an HTTP or import adaptor
|
|
7707
|
+
returned by an HTTP or import adaptor, and on a postResponseMap hook's errors, where it is the
|
|
7708
|
+
destination's stored reply (`statusCode`, `id`, `_json`); carries fields like `data[]`, `errors[]`,
|
|
7671
7709
|
`subGroupIdMapForSuccess`, `resultRecordIds`, `dataURIs`, `groupId`, `recordId`,
|
|
7672
7710
|
and `ignoredResults`. Treat the shape as opaque — it varies by adaptor — and pass it through
|
|
7673
7711
|
unchanged when PUT-ing the envelope back.
|
package/dist/job.yml
CHANGED
|
@@ -1599,14 +1599,19 @@ components:
|
|
|
1599
1599
|
doneExporting:
|
|
1600
1600
|
type: boolean
|
|
1601
1601
|
readOnly: true
|
|
1602
|
-
description:
|
|
1602
|
+
description: |-
|
|
1603
|
+
When true, all export pages have been generated. Observed exception: parent flow jobs
|
|
1604
|
+
read false after their runs completed (runs of an HTTP export into an HTTP import, read
|
|
1605
|
+
again minutes after they ended, 2026-10-23); `status` says whether a run finished.
|
|
1603
1606
|
numPagesProcessed:
|
|
1604
1607
|
type: integer
|
|
1605
1608
|
readOnly: true
|
|
1606
1609
|
description: |-
|
|
1607
1610
|
Number of pages processed by downstream steps: imports and lookup steps. A source export's
|
|
1608
1611
|
child job reads 0, a lookup step's and an import's count the pages they processed, and a
|
|
1609
|
-
parent flow job sums its children.
|
|
1612
|
+
parent flow job sums its children. Observed exception: on those same runs the parent read 0
|
|
1613
|
+
while its import job read 1; when a parent reads 0, read the step jobs
|
|
1614
|
+
(`GET /v1/jobs/{_id}/family`).
|
|
1610
1615
|
examples:
|
|
1611
1616
|
- 10
|
|
1612
1617
|
oIndex:
|
package/dist/tool.yml
CHANGED
|
@@ -31951,7 +31951,7 @@ components:
|
|
|
31951
31951
|
|
|
31952
31952
|
When this export is the first lookup of a builder-mode API with `pagination.enabled` set, it is that API's volume driver: saving the export (even unchanged) invalidates the API's issued cursors, so a caller mid-walk gets an empty final page, and removing `paging` is accepted on save but makes every call to the API fail with `400 api_pagination_source_not_paged` until paging is restored or the API's flag is turned off.
|
|
31953
31953
|
|
|
31954
|
-
When a next page's response is identical to the previous one, paging stops: the export records an open error with code `page_response_error` ("Identical response received from next page request. No more page requests will be made.") and
|
|
31954
|
+
When a next page's response is identical to the previous one, paging stops: the export records an open error with code `page_response_error` ("Identical response received from next page request. No more page requests will be made.") and later pages are never exported. A request that doesn't change between pages produces this, as observed with `method: page` and the pagination variable missing from the relative URI and body; reference the variable so each request asks for the next page. In that probe (an HTTP export, 2026-10-23) the run completed with the pages already read when the export had no `type`, and failed when it had `type: "delta"`: the steps after the export received nothing and the checkpoint didn't move. Other `type` values weren't tried. An invoke of that export, or a virtual export of the same document, answered 200 with the records read, then `{"errors": [...]}` carrying the `page_response_error`, as two JSON objects in one `text/plain` body.
|
|
31955
31955
|
x-celigo-ai-guidance:
|
|
31956
31956
|
- Configuration object for navigating through multi-page API responses.
|
|
31957
31957
|
- |-
|
package/package.json
CHANGED