@celigo/api-specs 0.2.172 → 0.2.174

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/tool.yml CHANGED
@@ -776,6 +776,15 @@ paths:
776
776
  format: objectId
777
777
  examples:
778
778
  - 6ac1ef4a38b24d95ffac2545: 6ac1ef4a38b24d95ffac2545
779
+ _stackId:
780
+ type: string
781
+ format: objectId
782
+ x-celigo-refModel: stacks
783
+ description: |-
784
+ Stack that the cloned steps' stack references point at. Required when the clone
785
+ preview reports `stackRequired: true` (400 `stack_not_found` without it).
786
+ examples:
787
+ - 5f8d43a1b9e5a80011a35f2c
779
788
  examples:
780
789
  default:
781
790
  summary: Clone a tool with no connection-bearing steps into the same integration
@@ -6358,7 +6367,9 @@ components:
6358
6367
  Reference to a predefined script resource containing the transformation logic.
6359
6368
 
6360
6369
  The referenced script should contain the function specified in the
6361
- 'function' property.
6370
+ 'function' property. It must be a script in this account: any other id fails the save
6371
+ with 422 ("Only a script owned by the user or a script shared by the Integration App can
6372
+ be used at transform.script._scriptId.").
6362
6373
  format: objectid
6363
6374
  x-celigo-refModel: scripts
6364
6375
  examples:
@@ -7721,11 +7732,13 @@ components:
7721
7732
  after which the flag switches itself off), and concurrency climbs back toward
7722
7733
  `targetConcurrencyLevel`. While true, `targetConcurrencyLevel` is the throughput lever: a
7723
7734
  `concurrencyLevel` sent in a PUT is ignored, and one sent in a PATCH is stored but the
7724
- recovery machinery moves it back toward the target.
7735
+ recovery machinery moves it back toward the target. Recovery never runs on `ftp`
7736
+ connections: FTP errors aren't treated as rate limits.
7725
7737
  x-celigo-ai-guidance:
7726
7738
  - To change throughput while this is true, write `targetConcurrencyLevel`; a `concurrencyLevel` sent in a PUT returns 200 and changes nothing.
7727
7739
  - Turning it on copies `concurrencyLevel` into `targetConcurrencyLevel`; turning it off unsets the target and leaves `concurrencyLevel` at its current value, which may be below the old target if a recovery was in progress. A `targetConcurrencyLevel` written while this is false is unset by the save.
7728
7740
  - These four settings (`concurrencyLevel`, `targetConcurrencyLevel`, `_borrowConcurrencyFromConnectionId`, this flag) accept a credential-free `PATCH /v1/connections/{_id}`. A PUT replaces the whole document, so send each secret back as its masked `******` value (that keeps it) or as a new value, and never drop one to keep it — an omitted password or `http.encrypted` is cleared, and a static token left out (with no `refreshMethod`) fails the PUT with 422.
7741
+ - On an `ftp` connection recovery never runs, and transfer threads are `ftp.multiThreadCount`; while this is true a create sets `ftp.concurrencyLevel` to `ftp.targetConcurrencyLevel`, or to 1 without one.
7729
7742
  enableMicroBatchForOneToMany:
7730
7743
  type: boolean
7731
7744
  default: true
@@ -8343,6 +8356,10 @@ components:
8343
8356
  FTP servers often have low connection limits — keep this value conservative.
8344
8357
  Send no more than the account's licensed maximum, the license's `concurrency` (25 standard,
8345
8358
  50 with an Environments license).
8359
+ While `autoRecoverRateLimitErrors` is true, which a create gets unless it sends `false`, a create
8360
+ ignores the value sent here and sets this field to `targetConcurrencyLevel`, or to 1 when no
8361
+ target is sent. To start higher, send `targetConcurrencyLevel` too, or create with
8362
+ `autoRecoverRateLimitErrors: false`.
8346
8363
  Unlike the rest of the `ftp` object, a `PUT` that omits this field keeps the stored value instead of clearing it.
8347
8364
  minimum: 1
8348
8365
  maximum: 50
@@ -8352,8 +8369,9 @@ components:
8352
8369
  targetConcurrencyLevel:
8353
8370
  type: integer
8354
8371
  description: |
8355
- Target concurrency level for auto-scaling. The system adjusts concurrency
8356
- between 1 and this value based on server response feedback.
8372
+ While `autoRecoverRateLimitErrors` is true, a create sets `concurrencyLevel` to this value, and a
8373
+ create that omits it gets 1 for both. Auto-recovery never runs on FTP connections (FTP errors
8374
+ aren't treated as rate limits), so nothing climbs back to it.
8357
8375
  Kept on a `PUT` that omits it, like `concurrencyLevel`; unset by the save while
8358
8376
  `autoRecoverRateLimitErrors` is false.
8359
8377
  minimum: 1
@@ -8384,9 +8402,9 @@ components:
8384
8402
  type: integer
8385
8403
  readOnly: true
8386
8404
  description: |-
8387
- Server-maintained mirror of `multiThreadCount` used by concurrency
8388
- auto-scaling. Present only when rate-limit auto-recovery applies;
8389
- recomputed on save.
8405
+ Server-maintained mirror of `multiThreadCount`, present while
8406
+ `autoRecoverRateLimitErrors` is true and `targetConcurrencyLevel` is
8407
+ set; recomputed on save.
8390
8408
  if:
8391
8409
  properties:
8392
8410
  type:
@@ -24176,7 +24194,9 @@ components:
24176
24194
  x-celigo-refModel: scripts
24177
24195
  description: |
24178
24196
  Reference to the Script resource that contains the filtering logic. This must be a valid
24179
- ObjectId of a Script resource that exists in the system.
24197
+ ObjectId of a Script resource in this account: any other id fails the save with 422
24198
+ ("Only a script owned by the user or a script shared by the Integration App can be used
24199
+ at filter.script._scriptId.").
24180
24200
 
24181
24201
  The referenced script must contain the function specified in the `function` field
24182
24202
  and must be written to handle filtering specifically. The script receives
@@ -24235,7 +24255,11 @@ components:
24235
24255
  type: string
24236
24256
  format: objectId
24237
24257
  x-celigo-refModel: scripts
24238
- description: Script containing the hook function named in `function`. Send this or `_stackId`, not both.
24258
+ description: |-
24259
+ Script containing the hook function named in `function`. Send this or `_stackId`, not both.
24260
+ Must be a script in this account: any other id fails the save with 422, naming the hook,
24261
+ such as "Only a script owned by the user or a script shared by the Integration App can
24262
+ be used at hooks.preMap._scriptId." on an import's `preMap`.
24239
24263
  _stackId:
24240
24264
  type: string
24241
24265
  format: objectId
@@ -25862,6 +25886,15 @@ components:
25862
25886
  plus whatever this step's response mapping merges back. A value later steps need
25863
25887
  belongs in the source export's `preSavePage`, in this step's `postResponseMap` hook on
25864
25888
  the flow, or in the later import's own `preMap`.
25889
+
25890
+ The function returns one element per record in `options.data`, in order:
25891
+ `{ data: <record> }` sends the record and `{ errors: [{ code, message }] }` fails it.
25892
+ An element without `data` — `{}`, or the record itself returned unwrapped — skips that
25893
+ record with no error: nothing is sent and the record is reported `ignored: true` at
25894
+ stage `preMapHook`. A return with more or fewer elements fails every record on the page
25895
+ with `invalid_extension_response` ("Extension result doesn't contain the same number
25896
+ of elements as the request object. Expected 2, got 1. Extension returned statusCode
25897
+ 200"), source `pre_map_hook`.
25865
25898
  x-celigo-ai-guidance:
25866
25899
  - |-
25867
25900
  Pre-map JavaScript hook — runs once per page BEFORE the
@@ -25873,7 +25906,18 @@ components:
25873
25906
  renames — mappings handle those.
25874
25907
 
25875
25908
  Runtime contract: ``options.data[]`` (the page of upstream
25876
- records) → array of the same length.
25909
+ records) → array of the same length, each element
25910
+ ``{data: record}`` or ``{errors: [...]}``. A bare record in
25911
+ the returned array is skipped without an error, so
25912
+ ``options.data.map(r => { r.total = t; return r })`` sends
25913
+ nothing.
25914
+ - |-
25915
+ Verified live 2026-10-22 by invoking an HTTP import with a
25916
+ Mapper 2.0 number mapping: one ``{data: record}`` per record
25917
+ sent both records; the bare records sent nothing and both
25918
+ came back ``ignored: true``, ``stage: preMapHook``, with no
25919
+ error; one element for two records failed both with 422
25920
+ ``invalid_extension_response``.
25877
25921
  allOf:
25878
25922
  - $ref: '#/components/schemas/Hook'
25879
25923
  postMap:
@@ -38163,7 +38207,10 @@ components:
38163
38207
  type: string
38164
38208
  format: objectId
38165
38209
  x-celigo-refModel: scripts
38166
- description: Script containing the hook function named in `function`.
38210
+ description: |-
38211
+ Script containing the hook function named in `function`. Must be a script in this
38212
+ account: any other id fails the save with 422 ("Only a script owned by the user or
38213
+ a script shared by the Integration App can be used at hooks.preSavePage._scriptId.").
38167
38214
  examples:
38168
38215
  - 60a2c4e6f321d800129a1a3c
38169
38216
  - 5f8e7d2c1b54e6003a9c7e12
@@ -38274,7 +38321,10 @@ components:
38274
38321
  type: string
38275
38322
  format: objectId
38276
38323
  x-celigo-refModel: connectors
38277
- description: Connector this export was created from, set when the export is part of an installed integration app.
38324
+ description: |-
38325
+ Connector this export was created from, set when the export is part of an installed
38326
+ integration app. The app's install sets it: a create that sends it is refused with 403
38327
+ ("Cannot create an Integration App resource").
38278
38328
  unencrypted:
38279
38329
  type: object
38280
38330
  description: Custom configuration values stored without encryption and returned in API responses.
@@ -38432,12 +38482,18 @@ components:
38432
38482
  additionalProperties: true
38433
38483
  stackRequired:
38434
38484
  type: boolean
38435
- description: Whether the clone requires a stack (connector-level) environment to proceed.
38485
+ description: |-
38486
+ `true` when the resource or one of its dependencies references a stack (a hook or
38487
+ wrapper connection that runs on a stack). Send `_stackId` in the clone request: without
38488
+ it the clone fails with 400 `stack_not_found`.
38436
38489
  _stackId:
38437
38490
  type:
38438
38491
  - string
38439
38492
  - 'null'
38440
- description: The stack id associated with the resource, or null if no stack is involved.
38493
+ description: |-
38494
+ The first stack the resource or a dependency references, or null. Pass it, or another
38495
+ stack in the target environment, as `_stackId` in the clone request; the clone points
38496
+ every stack reference at that one stack.
38441
38497
  examples:
38442
38498
  - 5f8d43a1b9e5a80011a35f2c
38443
38499
  DependencyEntry:
@@ -928,7 +928,9 @@ components:
928
928
  x-celigo-refModel: scripts
929
929
  description: |
930
930
  Reference to the Script resource that contains the filtering logic. This must be a valid
931
- ObjectId of a Script resource that exists in the system.
931
+ ObjectId of a Script resource in this account: any other id fails the save with 422
932
+ ("Only a script owned by the user or a script shared by the Integration App can be used
933
+ at filter.script._scriptId.").
932
934
 
933
935
  The referenced script must contain the function specified in the `function` field
934
936
  and must be written to handle filtering specifically. The script receives
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@celigo/api-specs",
3
- "version": "0.2.172",
3
+ "version": "0.2.174",
4
4
  "private": false,
5
5
  "description": "Public OpenAPI bundles (dist/) and the celigo-cli lint schema pack (schemas.json).",
6
6
  "keywords": [
package/schemas.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "provenance": {
3
3
  "repo": "celigo/integrator-api-specs",
4
- "iasCommit": "a3b6728d",
4
+ "iasCommit": "ea1eb137",
5
5
  "generatedAt": "2026-10-22"
6
6
  },
7
7
  "roots": {