@celigo/api-specs 0.2.56 → 0.2.58
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 +20 -1
- package/dist/tool.yml +20 -1
- package/package.json +1 -1
- package/schemas.json +1 -1
package/dist/export.yml
CHANGED
|
@@ -7634,7 +7634,7 @@ components:
|
|
|
7634
7634
|
- recordId
|
|
7635
7635
|
successPath:
|
|
7636
7636
|
type: string
|
|
7637
|
-
description: Path to a response field that signals whether the call succeeded, for APIs that return HTTP 200 even on failure.
|
|
7637
|
+
description: 'Path to a response field that signals whether the call succeeded, for APIs that return HTTP 200 even on failure. With `successValues`, the value at this path must match one of them; without `successValues`, the path only has to resolve — a response in which it is absent fails with `response_failure` ("Unable to extract paths from response body using path: <path>, Response: …").'
|
|
7638
7638
|
x-celigo-ai-guidance:
|
|
7639
7639
|
- |-
|
|
7640
7640
|
Use this when the API returns HTTP 200 for all requests but signals success or
|
|
@@ -7642,6 +7642,25 @@ components:
|
|
|
7642
7642
|
- |-
|
|
7643
7643
|
Example: If the API returns `{"status": "ok", "data": [...]}`,
|
|
7644
7644
|
set `successPath` to `status` and `successValues` to `["ok"]`.
|
|
7645
|
+
- |-
|
|
7646
|
+
On a LOOKUP step this is also the way to make "no match" fail the record. A lookup
|
|
7647
|
+
whose `resourcePath` resolves to nothing returns zero records and the platform counts
|
|
7648
|
+
that as success: the record continues to the next step with nothing merged, and the
|
|
7649
|
+
flow's `pageProcessors[].proceedOnFailure` for that step has no bearing on it. Set
|
|
7650
|
+
`successPath` (no `successValues`) to a path that exists only when a match was found,
|
|
7651
|
+
e.g. `results[0].id`: an empty result then fails the record with `response_failure`
|
|
7652
|
+
(`Unable to extract paths from response body using path: results[0].id, Response:
|
|
7653
|
+
{…}`), and `proceedOnFailure: true` on that step lets the failed record continue.
|
|
7654
|
+
Live-verified 2026-09-24 in real flow runs (listener -> HTTP lookup -> import, one
|
|
7655
|
+
record each): empty result with no `successPath` -> lookup 1 success, import 1
|
|
7656
|
+
success, with or without `proceedOnFailure`; `successPath` on an absent path ->
|
|
7657
|
+
lookup 1 error with that message, import 0 (1 with `proceedOnFailure: true`);
|
|
7658
|
+
`successPath` on a present path -> success. The error text is generic; for a custom
|
|
7659
|
+
message a `preSavePage` hook on the lookup that returns one `newErrorsAndRetryData`
|
|
7660
|
+
entry (`{errors: [{code: 404, message: "Product not found"}]}`) when `options.data`
|
|
7661
|
+
and `options.errors` are both empty failed the record with "Product not found" in
|
|
7662
|
+
the same runs. Lookups on adaptors without HTTP response settings (NetSuite, for
|
|
7663
|
+
example) have no `successPath`.
|
|
7645
7664
|
examples:
|
|
7646
7665
|
- status
|
|
7647
7666
|
- success
|
package/dist/tool.yml
CHANGED
|
@@ -30628,7 +30628,7 @@ components:
|
|
|
30628
30628
|
- recordId
|
|
30629
30629
|
successPath:
|
|
30630
30630
|
type: string
|
|
30631
|
-
description: Path to a response field that signals whether the call succeeded, for APIs that return HTTP 200 even on failure.
|
|
30631
|
+
description: 'Path to a response field that signals whether the call succeeded, for APIs that return HTTP 200 even on failure. With `successValues`, the value at this path must match one of them; without `successValues`, the path only has to resolve — a response in which it is absent fails with `response_failure` ("Unable to extract paths from response body using path: <path>, Response: …").'
|
|
30632
30632
|
x-celigo-ai-guidance:
|
|
30633
30633
|
- |-
|
|
30634
30634
|
Use this when the API returns HTTP 200 for all requests but signals success or
|
|
@@ -30636,6 +30636,25 @@ components:
|
|
|
30636
30636
|
- |-
|
|
30637
30637
|
Example: If the API returns `{"status": "ok", "data": [...]}`,
|
|
30638
30638
|
set `successPath` to `status` and `successValues` to `["ok"]`.
|
|
30639
|
+
- |-
|
|
30640
|
+
On a LOOKUP step this is also the way to make "no match" fail the record. A lookup
|
|
30641
|
+
whose `resourcePath` resolves to nothing returns zero records and the platform counts
|
|
30642
|
+
that as success: the record continues to the next step with nothing merged, and the
|
|
30643
|
+
flow's `pageProcessors[].proceedOnFailure` for that step has no bearing on it. Set
|
|
30644
|
+
`successPath` (no `successValues`) to a path that exists only when a match was found,
|
|
30645
|
+
e.g. `results[0].id`: an empty result then fails the record with `response_failure`
|
|
30646
|
+
(`Unable to extract paths from response body using path: results[0].id, Response:
|
|
30647
|
+
{…}`), and `proceedOnFailure: true` on that step lets the failed record continue.
|
|
30648
|
+
Live-verified 2026-09-24 in real flow runs (listener -> HTTP lookup -> import, one
|
|
30649
|
+
record each): empty result with no `successPath` -> lookup 1 success, import 1
|
|
30650
|
+
success, with or without `proceedOnFailure`; `successPath` on an absent path ->
|
|
30651
|
+
lookup 1 error with that message, import 0 (1 with `proceedOnFailure: true`);
|
|
30652
|
+
`successPath` on a present path -> success. The error text is generic; for a custom
|
|
30653
|
+
message a `preSavePage` hook on the lookup that returns one `newErrorsAndRetryData`
|
|
30654
|
+
entry (`{errors: [{code: 404, message: "Product not found"}]}`) when `options.data`
|
|
30655
|
+
and `options.errors` are both empty failed the record with "Product not found" in
|
|
30656
|
+
the same runs. Lookups on adaptors without HTTP response settings (NetSuite, for
|
|
30657
|
+
example) have no `successPath`.
|
|
30639
30658
|
examples:
|
|
30640
30659
|
- status
|
|
30641
30660
|
- success
|
package/package.json
CHANGED