@celigo/api-specs 0.2.213 → 0.2.214

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.
@@ -5121,11 +5121,22 @@ components:
5121
5121
  format: objectId
5122
5122
  x-celigo-refModel: agents
5123
5123
  description: |
5124
- Reference to a Celigo on-premise Agent. Required for connection types that need
5125
- local network or filesystem access (JDBC, filesystem, Oracle RDBMS, and on-premise MongoDB).
5124
+ Reference to a Celigo on-premise Agent. Connection types that need local network or
5125
+ filesystem access (JDBC, filesystem, Oracle RDBMS, and on-premise MongoDB) carry one
5126
+ binding — this agent, or an agent group in `_agentGroupId`; never both.
5126
5127
  The agent establishes a secure tunnel between the on-premise environment and integrator.io.
5127
5128
  examples:
5128
5129
  - 5f8d43a1b9e5a80011a35f2c
5130
+ _agentGroupId:
5131
+ type: string
5132
+ format: objectId
5133
+ x-celigo-refModel: agentgroups
5134
+ description: |-
5135
+ On-premise agent group serving this connection, when one is bound
5136
+ instead of a single `_agentId`. Absent on connections that use a
5137
+ single agent or none.
5138
+ examples:
5139
+ - 6650a1b2c3d4e5f60718293a
5129
5140
  _borrowConcurrencyFromConnectionId:
5130
5141
  type: string
5131
5142
  format: objectId
@@ -7903,8 +7914,10 @@ components:
7903
7914
  x-celigo-ai-guidance:
7904
7915
  - The POST is rejected with 422 if type-specific required fields are missing (see the per-type conditional rules).
7905
7916
  - |-
7906
- For Oracle, a placeholder connection cannot be created without a real connection-level _agentId
7907
- (validator error agent_mode_only) — direct the user to install a Celigo Agent first. All other
7917
+ For Oracle, a placeholder connection cannot be created without a real on-premise binding — a
7918
+ connection-level _agentId, or an agent group through _agentGroupId (validator error
7919
+ agent_mode_only with neither; live-verified that a POST carrying only _agentGroupId is not
7920
+ answered with it) — direct the user to install a Celigo Agent first. All other
7908
7921
  RDBMS types accept placeholder credentials that satisfy the per-type required fields.
7909
7922
  - |-
7910
7923
  Celigo has native support for these database systems:
@@ -7955,16 +7968,17 @@ components:
7955
7968
  `_iClientId` with `basic` auth is rejected. Both types share the
7956
7969
  `mssql` sub-object; `azuresynapse` is cloud-only, and the SQL Server
7957
7970
  connection form offers service-principal auth in Cloud mode only — it
7958
- saves `basic` for an on-premise connection (`_agentId` set).
7959
- - **Oracle** — runs in agent mode only, so requires `_agentId` on the
7960
- parent connection object. Uses `serviceName` instead of `database`.
7971
+ saves `basic` for an on-premise connection (`_agentId` or `_agentGroupId` set).
7972
+ - **Oracle** — runs in agent mode only, so requires an on-premise binding on
7973
+ the parent connection object: `_agentId`, or an agent group's `_agentGroupId`
7974
+ (one of the two, never both). Uses `serviceName` instead of `database`.
7961
7975
  Optionally also takes `serverType` and `instanceName`.
7962
7976
 
7963
7977
  ## PLACEHOLDER / DUMMY RDBMS CONNECTIONS
7964
7978
 
7965
7979
  For Oracle, placeholder connections cannot be created without a real
7966
- `_agentId` — the validator will reject them. Direct the user to install
7967
- a Celigo Agent first. For all other RDBMS types, a placeholder can be
7980
+ `_agentId` or `_agentGroupId` — the validator will reject them. Direct the
7981
+ user to install a Celigo Agent first. For all other RDBMS types, a placeholder can be
7968
7982
  created with dummy credentials matching the rules above.
7969
7983
  x-celigo-ui-override: 'Several requireds mirror the connection form rather than the API: snowflake.warehouse, redshift.clusterIdentifier, redshift.user, and mssql version. The API creates connections without them (live-verified 201), but the form requires them and a functional connection needs them. For mysql, postgresql, and mariadb the form makes password conditional — not required when a full SSL client certificate (ssl.ca, ssl.key, ssl.cert) is supplied instead; the conditional below keeps password required for the common (non-SSL) path, which is the only path the API enforces.'
7970
7984
  required:
@@ -7987,7 +8001,7 @@ components:
7987
8001
  postgresql: PostgreSQL database (default port 5432).
7988
8002
  mssql: Microsoft SQL Server (default port 1433).
7989
8003
  snowflake: Snowflake Data Cloud (requires snowflake.warehouse).
7990
- oracle: Oracle Database; runs in agent mode and requires a connection-level _agentId (default port 1521, uses serviceName instead of database).
8004
+ oracle: Oracle Database; runs in agent mode and requires a connection-level _agentId or _agentGroupId (default port 1521, uses serviceName instead of database).
7991
8005
  bigquery: Google BigQuery; requires service account credentials in the bigquery sub-object.
7992
8006
  redshift: Amazon Redshift — provisioned clusters or Redshift Serverless; authenticates with static access keys or an AWS IAM role iClient (redshift.authType).
7993
8007
  mariadb: MariaDB database (default port 3306).
@@ -8212,7 +8226,7 @@ components:
8212
8226
  iClient — a client secret, or on SQL Server a certificate — and
8213
8227
  `_iClientId` must reference it. The SQL Server connection form
8214
8228
  offers `azure-service-principal` in Cloud mode only and saves
8215
- `basic` for an on-premise connection (`_agentId` set).
8229
+ `basic` for an on-premise connection (`_agentId` or `_agentGroupId` set).
8216
8230
  default: basic
8217
8231
  examples:
8218
8232
  - basic
@@ -8678,9 +8692,9 @@ components:
8678
8692
  422 "Expected field: <field> to be present" if any of the three is missing. database is not
8679
8693
  required; when omitted, set it per operation instead.
8680
8694
  - |-
8681
- For an on-premise MongoDB instance, set the connection-level _agentId (the form's "On-premise"
8682
- mode) so traffic routes through a Celigo Agent. Cloud-reachable instances (including Atlas)
8683
- need no agent.
8695
+ For an on-premise MongoDB instance, bind the connection to one agent (connection-level
8696
+ _agentId) or to one agent group (_agentGroupId) — the form's "On-premise" mode — so traffic
8697
+ routes through a Celigo Agent. Cloud-reachable instances (including Atlas) need no agent.
8684
8698
  - |-
8685
8699
  ## AUTHENTICATION
8686
8700
  Username and password are optional — only required when the MongoDB server has
@@ -9380,8 +9394,8 @@ components:
9380
9394
  description: |-
9381
9395
  Configuration for filesystem connections. Used when the connection type is "filesystem".
9382
9396
  Provides access to directories on a Celigo on-premise Agent's host or mounted network
9383
- drives, so a connection-level `_agentId` is required — cloud-only deployments cannot use
9384
- this type. File-based PGP encryption/decryption is configured through the connection-level
9397
+ drives, so an on-premise binding is required — a connection-level `_agentId`, or an agent
9398
+ group through `_agentGroupId` — and cloud-only deployments cannot use this type. File-based PGP encryption/decryption is configured through the connection-level
9385
9399
  `pgp` object.
9386
9400
  properties:
9387
9401
  ping:
@@ -9427,9 +9441,10 @@ components:
9427
9441
  mounted network drives.
9428
9442
 
9429
9443
  ## AGENT REQUIREMENT
9430
- A Celigo Agent is REQUIRED for filesystem connections (set _agentId on the parent
9431
- connection object). The agent provides the filesystem access — cloud-only
9432
- deployments cannot use this connection type.
9444
+ A Celigo Agent is REQUIRED for filesystem connections: bind the parent connection
9445
+ object to one agent (_agentId) or to one agent group (_agentGroupId) — one of the
9446
+ two, never both. The agent provides the filesystem access — cloud-only deployments
9447
+ cannot use this connection type.
9433
9448
  token:
9434
9449
  type: object
9435
9450
  description: |
@@ -9903,13 +9918,17 @@ components:
9903
9918
  Configuration for JDBC (Java Database Connectivity) connections. Used when the connection
9904
9919
  type is "jdbc". Provides access through Java JDBC drivers to databases not covered by the
9905
9920
  rdbms type — such as NetSuite SuiteAnalytics, Databricks, DB2, and Workday. The driver runs
9906
- on a Celigo on-premise Agent, so most jdbc connections need a connection-level _agentId.
9921
+ on a Celigo on-premise Agent, so most jdbc connections need an on-premise binding — a
9922
+ connection-level _agentId, or an agent group through _agentGroupId.
9907
9923
  x-celigo-ai-guidance:
9908
9924
  - The POST is rejected with 422 if type-specific required fields are missing (see the per-type conditional rules).
9909
9925
  - |-
9910
- The agent and activedirectory types require a real connection-level _agentId: the POST fails with
9911
- 422 "The JDBC connection requires Agent. Expected field: _agentId to be present in the connection
9912
- doc." A placeholder cannot be created without one, so the user should install a Celigo Agent first.
9926
+ The agent and activedirectory types require a real on-premise binding — a connection-level
9927
+ _agentId, or an agent group through _agentGroupId (one of the two, never both; the agent-mode
9928
+ check accepts either — live-verified for both agent and activedirectory: a POST carrying only
9929
+ _agentGroupId is not answered with agent_mode_only): with neither, the POST fails with 422 "The JDBC
9930
+ connection requires Agent. Expected field: _agentId to be present in the connection doc." A
9931
+ placeholder cannot be created without one, so the user should install a Celigo Agent first.
9913
9932
  Other types commonly run on an agent too, but only these two are validator-enforced (live-verified
9914
9933
  celigo-labs-2 2026-06-11).
9915
9934
  x-celigo-ui-override: 'Two activedirectory requireds mirror the connection form rather than the API: password and port (default 389). The API creates an activedirectory connection without them (it auto-defaults port to 389), but the form requires both, so they are encoded to mirror the form. The workday user and password requireds are NOT form overrides — they are enforced by the API itself (POST returns 422 "Expected field: user/password to be present"). Per-type forms also require named entries inside jdbc.properties (netsuitejdbc AccountID + ServerDataSource; db2 AuthScheme; workday tenant/connectionType/authScheme; activedirectory LDAPVersion/BaseDN) — documented in prose since they live in the properties name/value array.'
package/dist/tool.yml CHANGED
@@ -7709,11 +7709,22 @@ components:
7709
7709
  format: objectId
7710
7710
  x-celigo-refModel: agents
7711
7711
  description: |
7712
- Reference to a Celigo on-premise Agent. Required for connection types that need
7713
- local network or filesystem access (JDBC, filesystem, Oracle RDBMS, and on-premise MongoDB).
7712
+ Reference to a Celigo on-premise Agent. Connection types that need local network or
7713
+ filesystem access (JDBC, filesystem, Oracle RDBMS, and on-premise MongoDB) carry one
7714
+ binding — this agent, or an agent group in `_agentGroupId`; never both.
7714
7715
  The agent establishes a secure tunnel between the on-premise environment and integrator.io.
7715
7716
  examples:
7716
7717
  - 5f8d43a1b9e5a80011a35f2c
7718
+ _agentGroupId:
7719
+ type: string
7720
+ format: objectId
7721
+ x-celigo-refModel: agentgroups
7722
+ description: |-
7723
+ On-premise agent group serving this connection, when one is bound
7724
+ instead of a single `_agentId`. Absent on connections that use a
7725
+ single agent or none.
7726
+ examples:
7727
+ - 6650a1b2c3d4e5f60718293a
7717
7728
  _borrowConcurrencyFromConnectionId:
7718
7729
  type: string
7719
7730
  format: objectId
@@ -10491,8 +10502,10 @@ components:
10491
10502
  x-celigo-ai-guidance:
10492
10503
  - The POST is rejected with 422 if type-specific required fields are missing (see the per-type conditional rules).
10493
10504
  - |-
10494
- For Oracle, a placeholder connection cannot be created without a real connection-level _agentId
10495
- (validator error agent_mode_only) — direct the user to install a Celigo Agent first. All other
10505
+ For Oracle, a placeholder connection cannot be created without a real on-premise binding — a
10506
+ connection-level _agentId, or an agent group through _agentGroupId (validator error
10507
+ agent_mode_only with neither; live-verified that a POST carrying only _agentGroupId is not
10508
+ answered with it) — direct the user to install a Celigo Agent first. All other
10496
10509
  RDBMS types accept placeholder credentials that satisfy the per-type required fields.
10497
10510
  - |-
10498
10511
  Celigo has native support for these database systems:
@@ -10543,16 +10556,17 @@ components:
10543
10556
  `_iClientId` with `basic` auth is rejected. Both types share the
10544
10557
  `mssql` sub-object; `azuresynapse` is cloud-only, and the SQL Server
10545
10558
  connection form offers service-principal auth in Cloud mode only — it
10546
- saves `basic` for an on-premise connection (`_agentId` set).
10547
- - **Oracle** — runs in agent mode only, so requires `_agentId` on the
10548
- parent connection object. Uses `serviceName` instead of `database`.
10559
+ saves `basic` for an on-premise connection (`_agentId` or `_agentGroupId` set).
10560
+ - **Oracle** — runs in agent mode only, so requires an on-premise binding on
10561
+ the parent connection object: `_agentId`, or an agent group's `_agentGroupId`
10562
+ (one of the two, never both). Uses `serviceName` instead of `database`.
10549
10563
  Optionally also takes `serverType` and `instanceName`.
10550
10564
 
10551
10565
  ## PLACEHOLDER / DUMMY RDBMS CONNECTIONS
10552
10566
 
10553
10567
  For Oracle, placeholder connections cannot be created without a real
10554
- `_agentId` — the validator will reject them. Direct the user to install
10555
- a Celigo Agent first. For all other RDBMS types, a placeholder can be
10568
+ `_agentId` or `_agentGroupId` — the validator will reject them. Direct the
10569
+ user to install a Celigo Agent first. For all other RDBMS types, a placeholder can be
10556
10570
  created with dummy credentials matching the rules above.
10557
10571
  x-celigo-ui-override: 'Several requireds mirror the connection form rather than the API: snowflake.warehouse, redshift.clusterIdentifier, redshift.user, and mssql version. The API creates connections without them (live-verified 201), but the form requires them and a functional connection needs them. For mysql, postgresql, and mariadb the form makes password conditional — not required when a full SSL client certificate (ssl.ca, ssl.key, ssl.cert) is supplied instead; the conditional below keeps password required for the common (non-SSL) path, which is the only path the API enforces.'
10558
10572
  required:
@@ -10575,7 +10589,7 @@ components:
10575
10589
  postgresql: PostgreSQL database (default port 5432).
10576
10590
  mssql: Microsoft SQL Server (default port 1433).
10577
10591
  snowflake: Snowflake Data Cloud (requires snowflake.warehouse).
10578
- oracle: Oracle Database; runs in agent mode and requires a connection-level _agentId (default port 1521, uses serviceName instead of database).
10592
+ oracle: Oracle Database; runs in agent mode and requires a connection-level _agentId or _agentGroupId (default port 1521, uses serviceName instead of database).
10579
10593
  bigquery: Google BigQuery; requires service account credentials in the bigquery sub-object.
10580
10594
  redshift: Amazon Redshift — provisioned clusters or Redshift Serverless; authenticates with static access keys or an AWS IAM role iClient (redshift.authType).
10581
10595
  mariadb: MariaDB database (default port 3306).
@@ -10800,7 +10814,7 @@ components:
10800
10814
  iClient — a client secret, or on SQL Server a certificate — and
10801
10815
  `_iClientId` must reference it. The SQL Server connection form
10802
10816
  offers `azure-service-principal` in Cloud mode only and saves
10803
- `basic` for an on-premise connection (`_agentId` set).
10817
+ `basic` for an on-premise connection (`_agentId` or `_agentGroupId` set).
10804
10818
  default: basic
10805
10819
  examples:
10806
10820
  - basic
@@ -11266,9 +11280,9 @@ components:
11266
11280
  422 "Expected field: <field> to be present" if any of the three is missing. database is not
11267
11281
  required; when omitted, set it per operation instead.
11268
11282
  - |-
11269
- For an on-premise MongoDB instance, set the connection-level _agentId (the form's "On-premise"
11270
- mode) so traffic routes through a Celigo Agent. Cloud-reachable instances (including Atlas)
11271
- need no agent.
11283
+ For an on-premise MongoDB instance, bind the connection to one agent (connection-level
11284
+ _agentId) or to one agent group (_agentGroupId) — the form's "On-premise" mode — so traffic
11285
+ routes through a Celigo Agent. Cloud-reachable instances (including Atlas) need no agent.
11272
11286
  - |-
11273
11287
  ## AUTHENTICATION
11274
11288
  Username and password are optional — only required when the MongoDB server has
@@ -11968,8 +11982,8 @@ components:
11968
11982
  description: |-
11969
11983
  Configuration for filesystem connections. Used when the connection type is "filesystem".
11970
11984
  Provides access to directories on a Celigo on-premise Agent's host or mounted network
11971
- drives, so a connection-level `_agentId` is required — cloud-only deployments cannot use
11972
- this type. File-based PGP encryption/decryption is configured through the connection-level
11985
+ drives, so an on-premise binding is required — a connection-level `_agentId`, or an agent
11986
+ group through `_agentGroupId` — and cloud-only deployments cannot use this type. File-based PGP encryption/decryption is configured through the connection-level
11973
11987
  `pgp` object.
11974
11988
  properties:
11975
11989
  ping:
@@ -12015,9 +12029,10 @@ components:
12015
12029
  mounted network drives.
12016
12030
 
12017
12031
  ## AGENT REQUIREMENT
12018
- A Celigo Agent is REQUIRED for filesystem connections (set _agentId on the parent
12019
- connection object). The agent provides the filesystem access — cloud-only
12020
- deployments cannot use this connection type.
12032
+ A Celigo Agent is REQUIRED for filesystem connections: bind the parent connection
12033
+ object to one agent (_agentId) or to one agent group (_agentGroupId) — one of the
12034
+ two, never both. The agent provides the filesystem access — cloud-only deployments
12035
+ cannot use this connection type.
12021
12036
  token:
12022
12037
  type: object
12023
12038
  description: |
@@ -12491,13 +12506,17 @@ components:
12491
12506
  Configuration for JDBC (Java Database Connectivity) connections. Used when the connection
12492
12507
  type is "jdbc". Provides access through Java JDBC drivers to databases not covered by the
12493
12508
  rdbms type — such as NetSuite SuiteAnalytics, Databricks, DB2, and Workday. The driver runs
12494
- on a Celigo on-premise Agent, so most jdbc connections need a connection-level _agentId.
12509
+ on a Celigo on-premise Agent, so most jdbc connections need an on-premise binding — a
12510
+ connection-level _agentId, or an agent group through _agentGroupId.
12495
12511
  x-celigo-ai-guidance:
12496
12512
  - The POST is rejected with 422 if type-specific required fields are missing (see the per-type conditional rules).
12497
12513
  - |-
12498
- The agent and activedirectory types require a real connection-level _agentId: the POST fails with
12499
- 422 "The JDBC connection requires Agent. Expected field: _agentId to be present in the connection
12500
- doc." A placeholder cannot be created without one, so the user should install a Celigo Agent first.
12514
+ The agent and activedirectory types require a real on-premise binding — a connection-level
12515
+ _agentId, or an agent group through _agentGroupId (one of the two, never both; the agent-mode
12516
+ check accepts either — live-verified for both agent and activedirectory: a POST carrying only
12517
+ _agentGroupId is not answered with agent_mode_only): with neither, the POST fails with 422 "The JDBC
12518
+ connection requires Agent. Expected field: _agentId to be present in the connection doc." A
12519
+ placeholder cannot be created without one, so the user should install a Celigo Agent first.
12501
12520
  Other types commonly run on an agent too, but only these two are validator-enforced (live-verified
12502
12521
  celigo-labs-2 2026-06-11).
12503
12522
  x-celigo-ui-override: 'Two activedirectory requireds mirror the connection form rather than the API: password and port (default 389). The API creates an activedirectory connection without them (it auto-defaults port to 389), but the form requires both, so they are encoded to mirror the form. The workday user and password requireds are NOT form overrides — they are enforced by the API itself (POST returns 422 "Expected field: user/password to be present"). Per-type forms also require named entries inside jdbc.properties (netsuitejdbc AccountID + ServerDataSource; db2 AuthScheme; workday tenant/connectionType/authScheme; activedirectory LDAPVersion/BaseDN) — documented in prose since they live in the properties name/value array.'
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@celigo/api-specs",
3
- "version": "0.2.213",
3
+ "version": "0.2.214",
4
4
  "private": false,
5
5
  "description": "Public OpenAPI bundles (dist/) and the celigo-cli lint schema pack (schemas.json).",
6
6
  "keywords": [