@celigo/api-specs 0.2.120 → 0.2.122

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.
@@ -9392,6 +9392,127 @@ components:
9392
9392
  A value outside the platform's adaptor list fails with 422 `enum` on `assistant`
9393
9393
  ("`<value>` is not a valid enum value for path `assistant`."); for a connector-framework
9394
9394
  application with no legacy adaptor, link it through `http._httpConnectorId` instead.
9395
+ accessScope:
9396
+ type: object
9397
+ description: |-
9398
+ What a Celigo APIs connection (`assistant: integratorceligoapi`) may reach in the
9399
+ account: the account's custom APIs, listeners, standard integrator.io APIs and Celigo
9400
+ Storage folders. A Celigo APIs connection cannot be created without it; an update that
9401
+ omits it leaves the stored scope unchanged. The connection document never carries it —
9402
+ the stored scope is read from `GET /v1/accessScope/connections/{_id}`.
9403
+ required:
9404
+ - type
9405
+ properties:
9406
+ type:
9407
+ type: string
9408
+ enum:
9409
+ - full
9410
+ - custom
9411
+ - integration
9412
+ x-enumDescriptions:
9413
+ full: Every custom API, listener and standard integrator.io API in the account, and every Celigo Storage folder
9414
+ custom: Only the APIs, listeners and Celigo Storage folders listed in the sibling arrays
9415
+ integration: Only the integrations listed in `_integrationIds`
9416
+ description: |-
9417
+ How much of the account the connection may reach. Each type takes its own
9418
+ selections: `full` takes none, `custom` takes APIs, listeners and folder paths,
9419
+ `integration` takes integrations only.
9420
+ _apiIds:
9421
+ type: array
9422
+ items:
9423
+ type: string
9424
+ format: objectId
9425
+ x-celigo-refModel: apis
9426
+ description: Custom APIs the connection may invoke. Present when `type` is `custom`.
9427
+ _exportIds:
9428
+ type: array
9429
+ items:
9430
+ type: string
9431
+ format: objectId
9432
+ x-celigo-refModel: exports
9433
+ description: Listeners (webhook exports) the connection may trigger. Present when `type` is `custom`.
9434
+ _integrationIds:
9435
+ type: array
9436
+ items:
9437
+ type: string
9438
+ format: objectId
9439
+ x-celigo-refModel: integrations
9440
+ description: Integrations whose resources the connection may reach. Present when `type` is `integration`.
9441
+ _fileStoragePaths:
9442
+ type: array
9443
+ items:
9444
+ type: string
9445
+ description: |-
9446
+ Celigo Storage folder paths the connection may read and write, matched as prefixes
9447
+ — each path also grants every folder beneath it, `/` alone grants every folder, and
9448
+ there are no wildcards. Present when `type` is `custom`; a `custom` connection with
9449
+ the field omitted or empty has no Celigo Storage access.
9450
+ examples:
9451
+ - - /Reports/
9452
+ - /Inbound/EDI/
9453
+ - - /
9454
+ if:
9455
+ properties:
9456
+ type:
9457
+ const: full
9458
+ required:
9459
+ - type
9460
+ then:
9461
+ properties:
9462
+ _apiIds:
9463
+ maxItems: 0
9464
+ _exportIds:
9465
+ maxItems: 0
9466
+ _integrationIds:
9467
+ maxItems: 0
9468
+ _fileStoragePaths:
9469
+ maxItems: 0
9470
+ else:
9471
+ if:
9472
+ properties:
9473
+ type:
9474
+ const: integration
9475
+ required:
9476
+ - type
9477
+ then:
9478
+ required:
9479
+ - _integrationIds
9480
+ properties:
9481
+ _integrationIds:
9482
+ minItems: 1
9483
+ _apiIds:
9484
+ maxItems: 0
9485
+ _exportIds:
9486
+ maxItems: 0
9487
+ _fileStoragePaths:
9488
+ maxItems: 0
9489
+ else:
9490
+ properties:
9491
+ _integrationIds:
9492
+ maxItems: 0
9493
+ x-celigo-ai-guidance:
9494
+ - |-
9495
+ A Celigo APIs connection POST without `accessScope` fails with 422 `missing_required_field`
9496
+ ("Scope is required for this connection. Please select Full access or Custom."); a PUT
9497
+ without it is accepted and the stored scope is unchanged. A `type` outside the enum fails
9498
+ with 422 `enum`.
9499
+ - |-
9500
+ Each mismatch between `type` and the selections fails with 422 `invalid_access_scope` and
9501
+ names the field: `full` with any of `_apiIds`, `_exportIds`, `_integrationIds` or
9502
+ `_fileStoragePaths`; `custom` with `_integrationIds` ("Use \"integration\" access type");
9503
+ `integration` with no `_integrationIds`, or with `_apiIds`, `_exportIds` or
9504
+ `_fileStoragePaths`. An id that is not an existing API or integration fails with 422
9505
+ `invalid_ref`.
9506
+ - |-
9507
+ Choose the narrowest `type` the connection's use needs: a flow that reads or writes Celigo
9508
+ Storage files → `custom` with the folder paths it uses (`/Reports/` grants that folder and
9509
+ everything beneath it); specific custom APIs or listeners → `custom` with their ids; the
9510
+ standard integrator.io REST APIs → `full`. A `custom` connection with `_fileStoragePaths`
9511
+ omitted or empty has no storage access — its storage step fails at run time with 401.
9512
+ - |-
9513
+ The connection document never carries `accessScope`; read the stored scope from
9514
+ `GET /v1/accessScope/connections/{_id}` (`scope`, `apis`, `exports`, `integrations`,
9515
+ `fileStoragePaths`) rather than inferring it from the document.
9395
9516
  _agentId:
9396
9517
  type: string
9397
9518
  format: objectId
package/dist/flow.yml CHANGED
@@ -5545,11 +5545,14 @@ components:
5545
5545
  - array
5546
5546
  - 'null'
5547
5547
  description: |-
5548
- Flow IDs to trigger after this flow completes successfully. Accepts null as
5549
- equivalent to an empty list (the server also serves null on documents saved
5550
- that way). The trigger starts the next flow from its own source steps and passes
5551
- it no records; a trigger that fires while the next flow is already queued or running
5552
- is dropped, not queued, so several completions in quick succession start it once.
5548
+ Flow IDs to start when a run of this flow completes — the flow's "Next integration flow"
5549
+ setting in the UI; a run that completes with record-level errors still starts them, a run
5550
+ that fails or is canceled does not. Accepts null as equivalent to an empty list (the server
5551
+ also serves null on documents saved that way). Each next flow starts from its own source
5552
+ steps and receives no records; a trigger that fires while the next flow is already queued
5553
+ or running is dropped, not queued, so several completions in quick succession start it
5554
+ once, and a flow listed here cannot be deleted while this flow still references it
5555
+ (422 `dependencies_not_deleted`).
5553
5556
  items:
5554
5557
  type: string
5555
5558
  format: objectId
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@celigo/api-specs",
3
- "version": "0.2.120",
3
+ "version": "0.2.122",
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,8 +1,8 @@
1
1
  {
2
2
  "provenance": {
3
3
  "repo": "celigo/integrator-api-specs",
4
- "iasCommit": "a82ea4f6",
5
- "generatedAt": "2026-10-17"
4
+ "iasCommit": "ccabdcd6",
5
+ "generatedAt": "2026-10-19"
6
6
  },
7
7
  "roots": {
8
8
  "aiagent": 133,