@celigo/api-specs 0.2.162 → 0.2.163

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 CHANGED
@@ -1299,7 +1299,7 @@ components:
1299
1299
  description: Property names the model must include in the structured output.
1300
1300
  items:
1301
1301
  type: string
1302
- additionalproperties:
1302
+ additionalProperties:
1303
1303
  type: boolean
1304
1304
  description: When true, the structured output may include properties beyond those defined in `properties`.
1305
1305
  schema:
package/dist/export.yml CHANGED
@@ -628,16 +628,19 @@ paths:
628
628
  - Exports
629
629
  summary: Invoke an export and return its data
630
630
  description: |-
631
- Runs an existing export end-to-end and returns the fetched data (or errors)
631
+ Runs an existing export end-to-end and returns its records (or errors)
632
632
  synchronously. Unlike `POST /v1/flows/{_id}/run`, which starts a full flow
633
633
  job, this endpoint invokes a **single export** in isolation and returns the
634
- raw result directly in the response body.
634
+ result directly in the response body.
635
635
 
636
636
  The request body is optional — pass `{}` or omit the body entirely for
637
637
  exports that require no input. Some adaptor types accept a `data` array in
638
638
  the body to supply input records.
639
639
 
640
- On success, the response contains the export's fetched data. On
640
+ On success, the response contains the records as the export hands them
641
+ on: after its transform, output filter and preSavePage hook, so records
642
+ come back in their final shape and records the filter or hook drops aren't
643
+ returned. On
641
644
  application-level failure (e.g. the source system is unreachable), the
642
645
  endpoint still returns a successful HTTP status with the errors in an
643
646
  `errors` array — higher-level error codes are reserved for request-level
@@ -688,7 +691,8 @@ paths:
688
691
  responses:
689
692
  '200':
690
693
  description: |-
691
- Export completed. The response contains either the fetched data or an
694
+ Export completed. The response contains either the export's records
695
+ (after its transform, output filter and preSavePage hook) or an
692
696
  `errors` array if the export encountered application-level failures
693
697
  (connection timeout, file not found, etc.). Always inspect for errors
694
698
  even on 200.
@@ -1340,11 +1344,11 @@ components:
1340
1344
  Once:
1341
1345
  type: object
1342
1346
  description: |-
1343
- Configures flag-based exports that process each record exactly once. Required when the
1344
- export's type is "once"; omit for other export types. Each run retrieves records where the
1345
- tracking boolean field is false, then sets that field to true after successful processing so
1346
- later runs skip them; if a run fails, the flags are left unchanged and the records are
1347
- retried automatically on the next run.
1347
+ Configures flag-based exports that skip records an earlier run already processed. Required
1348
+ when the export's type is "once"; omit for other export types. Each run retrieves records
1349
+ where the tracking boolean field is false, then sets that field to true after successful
1350
+ processing so later runs skip them; if a run fails, the flags are left unchanged and the
1351
+ records are retried automatically on the next run.
1348
1352
  x-celigo-ai-guidance:
1349
1353
  - |-
1350
1354
  This object is REQUIRED when the export's type field is set to "once" and should
@@ -1369,7 +1373,6 @@ components:
1369
1373
  - One-time migrations where data should not be duplicated
1370
1374
  - Processing queues where records are marked as "processed"
1371
1375
  - Compliance scenarios requiring audit trails of exported records
1372
- - Implementing exactly-once delivery semantics
1373
1376
  - |-
1374
1377
  4. Error handling behavior:
1375
1378
  - If the export fails, the boolean fields remain unchanged
@@ -16523,6 +16526,8 @@ components:
16523
16526
  description: |-
16524
16527
  Custom JavaScript hooks that run at fixed points in the export lifecycle for
16525
16528
  transformations, validation, and filtering beyond what configuration alone can express.
16529
+ A hook name not listed here (an import's `preMap`, for example) is dropped on save
16530
+ without an error, so read `hooks` back after saving.
16526
16531
  properties:
16527
16532
  preSavePage:
16528
16533
  type: object
@@ -997,7 +997,7 @@ components:
997
997
  description: Property names the stored JSON Schema marks as required.
998
998
  items:
999
999
  type: string
1000
- additionalproperties:
1000
+ additionalProperties:
1001
1001
  type: boolean
1002
1002
  description: Whether the stored JSON Schema allows properties beyond those in `properties`.
1003
1003
  schema:
package/dist/iclient.yml CHANGED
@@ -318,8 +318,9 @@ paths:
318
318
  x-internal: false
319
319
  summary: Update an iClient
320
320
  description: |-
321
- Replaces an iClient. All mutable fields must be provided — omitted
322
- fields are reset to defaults. Secrets returned as `"******"` can be
321
+ Replaces an existing iClient; create one with `POST /v1/iclients`. All
322
+ mutable fields must be provided — omitted fields are reset to defaults.
323
+ Secrets returned as `"******"` can be
323
324
  sent back as-is to keep the existing value, except a Google service
324
325
  account: every update must include the full JSON key. An Azure
325
326
  service principal keeps its stored `clientSecret` or `certificate`
package/dist/import.yml CHANGED
@@ -9681,7 +9681,7 @@ components:
9681
9681
  description: Property names the model must include in the structured output.
9682
9682
  items:
9683
9683
  type: string
9684
- additionalproperties:
9684
+ additionalProperties:
9685
9685
  type: boolean
9686
9686
  description: When true, the structured output may include properties beyond those defined in `properties`.
9687
9687
  schema:
@@ -11072,7 +11072,7 @@ components:
11072
11072
  description: Property names the stored JSON Schema marks as required.
11073
11073
  items:
11074
11074
  type: string
11075
- additionalproperties:
11075
+ additionalProperties:
11076
11076
  type: boolean
11077
11077
  description: Whether the stored JSON Schema allows properties beyond those in `properties`.
11078
11078
  schema:
package/dist/tool.yml CHANGED
@@ -21194,7 +21194,7 @@ components:
21194
21194
  description: Property names the model must include in the structured output.
21195
21195
  items:
21196
21196
  type: string
21197
- additionalproperties:
21197
+ additionalProperties:
21198
21198
  type: boolean
21199
21199
  description: When true, the structured output may include properties beyond those defined in `properties`.
21200
21200
  schema:
@@ -22585,7 +22585,7 @@ components:
22585
22585
  description: Property names the stored JSON Schema marks as required.
22586
22586
  items:
22587
22587
  type: string
22588
- additionalproperties:
22588
+ additionalProperties:
22589
22589
  type: boolean
22590
22590
  description: Whether the stored JSON Schema allows properties beyond those in `properties`.
22591
22591
  schema:
@@ -26445,11 +26445,11 @@ components:
26445
26445
  Once:
26446
26446
  type: object
26447
26447
  description: |-
26448
- Configures flag-based exports that process each record exactly once. Required when the
26449
- export's type is "once"; omit for other export types. Each run retrieves records where the
26450
- tracking boolean field is false, then sets that field to true after successful processing so
26451
- later runs skip them; if a run fails, the flags are left unchanged and the records are
26452
- retried automatically on the next run.
26448
+ Configures flag-based exports that skip records an earlier run already processed. Required
26449
+ when the export's type is "once"; omit for other export types. Each run retrieves records
26450
+ where the tracking boolean field is false, then sets that field to true after successful
26451
+ processing so later runs skip them; if a run fails, the flags are left unchanged and the
26452
+ records are retried automatically on the next run.
26453
26453
  x-celigo-ai-guidance:
26454
26454
  - |-
26455
26455
  This object is REQUIRED when the export's type field is set to "once" and should
@@ -26474,7 +26474,6 @@ components:
26474
26474
  - One-time migrations where data should not be duplicated
26475
26475
  - Processing queues where records are marked as "processed"
26476
26476
  - Compliance scenarios requiring audit trails of exported records
26477
- - Implementing exactly-once delivery semantics
26478
26477
  - |-
26479
26478
  4. Error handling behavior:
26480
26479
  - If the export fails, the boolean fields remain unchanged
@@ -37708,6 +37707,8 @@ components:
37708
37707
  description: |-
37709
37708
  Custom JavaScript hooks that run at fixed points in the export lifecycle for
37710
37709
  transformations, validation, and filtering beyond what configuration alone can express.
37710
+ A hook name not listed here (an import's `preMap`, for example) is dropped on save
37711
+ without an error, so read `hooks` back after saving.
37711
37712
  properties:
37712
37713
  preSavePage:
37713
37714
  type: object
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@celigo/api-specs",
3
- "version": "0.2.162",
3
+ "version": "0.2.163",
4
4
  "private": false,
5
5
  "description": "Public OpenAPI bundles (dist/) and the celigo-cli lint schema pack (schemas.json).",
6
6
  "keywords": [