@celigo/api-specs 0.2.129 → 0.2.131
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/README.md +1 -1
- package/dist/flow.yml +74 -48
- package/dist/job.yml +1 -1
- package/package.json +1 -1
- package/schemas.json +2 -2
package/README.md
CHANGED
|
@@ -85,7 +85,7 @@ OpenAPI consumers can ignore them; validators and AI agents may find them useful
|
|
|
85
85
|
| `x-celigo-refModel` | ID fields | The resource type the ID points at (`flows`, `scripts`, and so on). |
|
|
86
86
|
| `x-celigo-ai-guidance` | Schemas and fields | Operational hints for AI agents: which default to choose, what to set when scaffolding, and the concrete failure that results from getting it wrong. |
|
|
87
87
|
| `x-celigo-ui-override` | Schemas and fields | Marks a requirement or default that mirrors the integrator.io form, which is stricter than the raw API, so generated configurations are complete and connectable. |
|
|
88
|
-
| `x-celigo-agent` | Expression fields |
|
|
88
|
+
| `x-celigo-agent` | Expression fields | The field's value is authored in an expression language or editor; its capability tags (`handlebars`, `sql`, `mapping`, …) tell an agent or tool which one. |
|
|
89
89
|
| `x-celigo-handlebars-context` | Handlebars fields | The data context the expression is evaluated against, such as `pre-mapped` or `post-mapped`. |
|
|
90
90
|
| `x-celigo-excludeAdaptorTypes` | Shared adaptor fields | Adaptor types the field does not apply to. |
|
|
91
91
|
| `x-lowercase`, `x-uppercase` | String fields | The API normalizes the value's case on save. |
|
package/dist/flow.yml
CHANGED
|
@@ -2965,8 +2965,8 @@ paths:
|
|
|
2965
2965
|
time-bounded `logging.debugUntil` debug window). Jobs older than the flow's log retention window will
|
|
2966
2966
|
return an empty `logs` array.
|
|
2967
2967
|
|
|
2968
|
-
For
|
|
2969
|
-
entry and call `POST .../logs/data/query` with the corresponding `stage`. To stitch an
|
|
2968
|
+
For per-stage data (an HTTP request and response, or a mapping's or script hook's input and
|
|
2969
|
+
output), pick an entry and call `POST .../logs/data/query` with the corresponding `stage`. To stitch an
|
|
2970
2970
|
export entry to its downstream imports, use the `traceKey` with
|
|
2971
2971
|
`POST .../logs/metadata/query`.
|
|
2972
2972
|
parameters:
|
|
@@ -3184,22 +3184,14 @@ paths:
|
|
|
3184
3184
|
- Flows
|
|
3185
3185
|
summary: Get per-stage execution log data for a record
|
|
3186
3186
|
description: |-
|
|
3187
|
-
Returns the decoded log data
|
|
3188
|
-
|
|
3189
|
-
|
|
3190
|
-
Stages are bubble-kind specific. The most useful values:
|
|
3191
|
-
- **Export / Lookup:** `apiCall` (HTTP request+response for HTTP exports), `transformation`,
|
|
3192
|
-
`outputFilter`, `responseMapping`.
|
|
3193
|
-
- **Import:** `apiCall`, `mapping`, `inputFilter`, `responseTransformation`.
|
|
3194
|
-
- **Router:** `routing` (branching decision).
|
|
3195
|
-
- **Any:** the `function` name from a configured script hook (e.g. `preMap`, `postMap`, `postSubmit`,
|
|
3196
|
-
`postResponseMap`, `preSavePage`) — populated only when the hook explicitly calls
|
|
3197
|
-
`options.logs.push(...)`.
|
|
3187
|
+
Returns the decoded log data for a single `(step, stage)` tuple within a flow run, such as the
|
|
3188
|
+
HTTP request and response a step sent or the input and output of its mapping or a script hook.
|
|
3198
3189
|
|
|
3199
3190
|
This is typically the terminal call in the drill-down sequence: `execution-logs` then
|
|
3200
|
-
`metadata/query` then `data/query`.
|
|
3201
|
-
|
|
3202
|
-
|
|
3191
|
+
`metadata/query` then `data/query`. An empty `logs` array does not show that the stage ran or
|
|
3192
|
+
that its name is valid: the server answers an unknown stage name the same way as a stage that
|
|
3193
|
+
captured nothing, so check the stage name and the job's `logMode` (`GET /v1/jobs/{_id}`)
|
|
3194
|
+
before concluding the step recorded nothing.
|
|
3203
3195
|
parameters:
|
|
3204
3196
|
- name: _id
|
|
3205
3197
|
in: path
|
|
@@ -3231,13 +3223,13 @@ paths:
|
|
|
3231
3223
|
groupId: 69e981ee18808f3e5ed1b2fd
|
|
3232
3224
|
recordId: '0'
|
|
3233
3225
|
stage: apiCall
|
|
3234
|
-
|
|
3235
|
-
summary: Fetch
|
|
3226
|
+
pre_map_hook:
|
|
3227
|
+
summary: Fetch a preMap hook's input and output for an import step
|
|
3236
3228
|
value:
|
|
3237
|
-
_expOrImpId:
|
|
3238
|
-
groupId:
|
|
3239
|
-
recordId:
|
|
3240
|
-
stage:
|
|
3229
|
+
_expOrImpId: 69a9aa5c54e3d9bd11b86d82
|
|
3230
|
+
groupId: 4tQqtS
|
|
3231
|
+
recordId: f0xVak
|
|
3232
|
+
stage: preMapHook
|
|
3241
3233
|
responses:
|
|
3242
3234
|
'200':
|
|
3243
3235
|
description: Log entries for the requested `(step, stage)`.
|
|
@@ -3261,8 +3253,31 @@ paths:
|
|
|
3261
3253
|
response:
|
|
3262
3254
|
statusCode: 200
|
|
3263
3255
|
errors: []
|
|
3264
|
-
|
|
3265
|
-
summary:
|
|
3256
|
+
pre_map_hook:
|
|
3257
|
+
summary: preMap hook stage — the hook's options and its return value
|
|
3258
|
+
value:
|
|
3259
|
+
logs:
|
|
3260
|
+
- log:
|
|
3261
|
+
timeStamp: '2026-04-23T02:51:51.402Z'
|
|
3262
|
+
groupId: 4tQqtS
|
|
3263
|
+
stage: preMapHook
|
|
3264
|
+
input:
|
|
3265
|
+
- data:
|
|
3266
|
+
- id: 1
|
|
3267
|
+
name: Acme Corp
|
|
3268
|
+
phone: 555-0100 x12
|
|
3269
|
+
_importId: 69a9aa5c54e3d9bd11b86d82
|
|
3270
|
+
testMode: false
|
|
3271
|
+
output:
|
|
3272
|
+
- data:
|
|
3273
|
+
id: 1
|
|
3274
|
+
name: Acme Corp
|
|
3275
|
+
phone: 555-0100 x12
|
|
3276
|
+
phoneExtension: '12'
|
|
3277
|
+
errors: []
|
|
3278
|
+
errors: []
|
|
3279
|
+
empty_result:
|
|
3280
|
+
summary: Nothing captured for the stage, or an unknown stage name
|
|
3266
3281
|
value:
|
|
3267
3282
|
logs: []
|
|
3268
3283
|
errors: []
|
|
@@ -7306,7 +7321,7 @@ components:
|
|
|
7306
7321
|
description: |-
|
|
7307
7322
|
Effective logging mode for this job, resolved from the flow's `logging.mode`
|
|
7308
7323
|
and the account-level logging preference. Common values: `basic` (default),
|
|
7309
|
-
`off`, `on`, `debug`.
|
|
7324
|
+
`detailed`, `off`, `on`, `debug`.
|
|
7310
7325
|
examples:
|
|
7311
7326
|
- basic
|
|
7312
7327
|
__lastPageGeneratorJob:
|
|
@@ -7926,7 +7941,8 @@ components:
|
|
|
7926
7941
|
type: object
|
|
7927
7942
|
description: |-
|
|
7928
7943
|
Request body for `POST /v1/flows/{_id}/jobs/{_jobId}/logs/data/query`.
|
|
7929
|
-
Fetches the
|
|
7944
|
+
Fetches the data one step captured at one execution stage for a record, or for the record's
|
|
7945
|
+
whole group at a group-level stage.
|
|
7930
7946
|
properties:
|
|
7931
7947
|
_expOrImpId:
|
|
7932
7948
|
type: string
|
|
@@ -7936,23 +7952,26 @@ components:
|
|
|
7936
7952
|
- 60a2c4e6f321d800129a1a3c
|
|
7937
7953
|
stage:
|
|
7938
7954
|
type: string
|
|
7939
|
-
description:
|
|
7940
|
-
|
|
7955
|
+
description: |-
|
|
7956
|
+
Execution stage whose data to return. `apiCall` holds the request and response an HTTP
|
|
7957
|
+
export or import sent. On a job whose `logMode` is `debug`, an export's transform and
|
|
7958
|
+
output filter record under `transformation` and `outputFilter`, an import's mapping and
|
|
7959
|
+
response mapping under `mapping` and `responseMapping`, and a script hook's `options` and
|
|
7960
|
+
return value under its hook type plus `Hook` (`preSavePageHook`, `preMapHook`,
|
|
7961
|
+
`postMapHook`, `postSubmitHook`, `postResponseMapHook`), whatever the function is called;
|
|
7962
|
+
neither the bare hook name (`preMap`) nor `<functionName>Hook` returns them (live-verified
|
|
7963
|
+
2026-10-20).
|
|
7964
|
+
examples:
|
|
7941
7965
|
- apiCall
|
|
7942
|
-
-
|
|
7943
|
-
-
|
|
7944
|
-
-
|
|
7945
|
-
-
|
|
7946
|
-
-
|
|
7947
|
-
-
|
|
7948
|
-
|
|
7949
|
-
|
|
7950
|
-
|
|
7951
|
-
postMap: Data captured by the postMap script hook via options.logs.push().
|
|
7952
|
-
postSubmit: Data captured by the postSubmit script hook via options.logs.push().
|
|
7953
|
-
postResponseMap: Data captured by the postResponseMap script hook via options.logs.push().
|
|
7954
|
-
transform: Data captured during the transformation stage.
|
|
7955
|
-
responseTransform: Data captured during the response transformation stage.
|
|
7966
|
+
- transformation
|
|
7967
|
+
- outputFilter
|
|
7968
|
+
- mapping
|
|
7969
|
+
- responseMapping
|
|
7970
|
+
- preSavePageHook
|
|
7971
|
+
- preMapHook
|
|
7972
|
+
- postMapHook
|
|
7973
|
+
- postSubmitHook
|
|
7974
|
+
- postResponseMapHook
|
|
7956
7975
|
groupId:
|
|
7957
7976
|
type: string
|
|
7958
7977
|
description: Batch id from the `execution-log` entry.
|
|
@@ -7971,12 +7990,19 @@ components:
|
|
|
7971
7990
|
ExecutionLogDataResponse:
|
|
7972
7991
|
type: object
|
|
7973
7992
|
description: |-
|
|
7974
|
-
Stage data for a
|
|
7975
|
-
`POST /v1/flows/{_id}/jobs/{_jobId}/logs/data/query`.
|
|
7976
|
-
|
|
7977
|
-
The payload inside `logs[].log` is stage-specific
|
|
7978
|
-
|
|
7979
|
-
|
|
7993
|
+
Stage data one step of a flow run recorded for a record, or for the record's whole group at a
|
|
7994
|
+
group-level stage. Returned by `POST /v1/flows/{_id}/jobs/{_jobId}/logs/data/query`.
|
|
7995
|
+
|
|
7996
|
+
The payload inside `logs[].log` is stage-specific (live-verified 2026-10-20):
|
|
7997
|
+
|
|
7998
|
+
- `apiCall`: the request's method and URI and the response's status code. A job whose `logMode` is
|
|
7999
|
+
`detailed` or `debug` also records each side's headers and body; a `basic` job does not.
|
|
8000
|
+
- `mapping`, `transformation`, `outputFilter`, `responseMapping`: a per-record entry carrying the
|
|
8001
|
+
record's `recordId`, the stage's `input`, and its `output` (`outputFilter` has `success` instead).
|
|
8002
|
+
- `preSavePageHook`, `preMapHook`, `postMapHook`, `postSubmitHook`: one entry for the record's whole
|
|
8003
|
+
group, with no `recordId`. `input` is a one-element array holding the `options` the hook received,
|
|
8004
|
+
and `output` holds what the hook returned.
|
|
8005
|
+
- `postResponseMapHook`: `recordId` is null, and `input` is the `options` object itself.
|
|
7980
8006
|
properties:
|
|
7981
8007
|
logs:
|
|
7982
8008
|
type: array
|
package/dist/job.yml
CHANGED
|
@@ -1620,7 +1620,7 @@ components:
|
|
|
1620
1620
|
description: |-
|
|
1621
1621
|
Effective logging mode for this job, resolved from the flow's `logging.mode`
|
|
1622
1622
|
and the account-level logging preference. Common values: `basic` (default),
|
|
1623
|
-
`off`, `on`, `debug`.
|
|
1623
|
+
`detailed`, `off`, `on`, `debug`.
|
|
1624
1624
|
examples:
|
|
1625
1625
|
- basic
|
|
1626
1626
|
__lastPageGeneratorJob:
|
package/package.json
CHANGED