@celigo/api-specs 0.2.103 → 0.2.104
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/api.yml +152 -81
- package/dist/connection.yml +152 -81
- package/dist/enduser.yml +152 -81
- package/dist/filestorage.yml +28 -5
- package/dist/iclient.yml +42 -13
- package/dist/lookupcache.yml +2 -2
- package/dist/mcp-server.yml +152 -81
- package/dist/tool.yml +152 -81
- package/package.json +1 -1
- package/schemas.json +1 -1
package/dist/tool.yml
CHANGED
|
@@ -9880,11 +9880,12 @@ components:
|
|
|
9880
9880
|
- `database` — required for every type EXCEPT `oracle` (uses `serviceName`)
|
|
9881
9881
|
and `bigquery` (uses `bigquery.dataset`).
|
|
9882
9882
|
- `user` — required for every type EXCEPT `bigquery`, `redshift`, and
|
|
9883
|
-
`mssql` with `mssql.authType=azure-service-principal`.
|
|
9883
|
+
`mssql` / `azuresynapse` with `mssql.authType=azure-service-principal`.
|
|
9884
9884
|
- `password` — required when no SSL cert material is provided AND the
|
|
9885
|
-
type is NOT `bigquery`, `redshift`, `snowflake`, or `mssql`
|
|
9886
|
-
`azure-service-principal` auth. When SSL cert
|
|
9887
|
-
without a password, both `ssl.key` and `ssl.cert`
|
|
9885
|
+
type is NOT `bigquery`, `redshift`, `snowflake`, or `mssql` /
|
|
9886
|
+
`azuresynapse` with `azure-service-principal` auth. When SSL cert
|
|
9887
|
+
material IS provided without a password, both `ssl.key` and `ssl.cert`
|
|
9888
|
+
become required.
|
|
9888
9889
|
- **Snowflake** — additionally requires `snowflake.warehouse` and
|
|
9889
9890
|
`snowflake.authType`. When `snowflake.authType=keyPair`, also
|
|
9890
9891
|
requires the `key` field at the rdbms level (the RSA private key).
|
|
@@ -9900,8 +9901,14 @@ components:
|
|
|
9900
9901
|
iClient holding the role ARN) plus exactly one of
|
|
9901
9902
|
`redshift.clusterIdentifier` (provisioned cluster) or
|
|
9902
9903
|
`redshift.workgroupName` (Redshift Serverless).
|
|
9903
|
-
- **MSSQL with `mssql.authType=azure-service-principal`**
|
|
9904
|
-
`_iClientId`
|
|
9904
|
+
- **MSSQL / Azure Synapse with `mssql.authType=azure-service-principal`**
|
|
9905
|
+
— requires `_iClientId` referencing an `azureserviceprincipal` iClient
|
|
9906
|
+
(the Microsoft Entra tenant id, client id and client secret or
|
|
9907
|
+
certificate live in the iClient); `user` and `password` are not used.
|
|
9908
|
+
`_iClientId` with `basic` auth is rejected. Both types share the
|
|
9909
|
+
`mssql` sub-object; `azuresynapse` is cloud-only, and the SQL Server
|
|
9910
|
+
connection form offers service-principal auth in Cloud mode only — it
|
|
9911
|
+
saves `basic` for an on-premise connection (`_agentId` set).
|
|
9905
9912
|
- **Oracle** — runs in agent mode only, so requires `_agentId` on the
|
|
9906
9913
|
parent connection object. Uses `serviceName` instead of `database`.
|
|
9907
9914
|
Optionally also takes `serverType` and `instanceName`.
|
|
@@ -9994,8 +10001,10 @@ components:
|
|
|
9994
10001
|
user:
|
|
9995
10002
|
type: string
|
|
9996
10003
|
description: |
|
|
9997
|
-
Database username for authentication.
|
|
9998
|
-
|
|
10004
|
+
Database username for authentication. Required for all types except
|
|
10005
|
+
BigQuery (service account auth), Redshift, and `mssql` / `azuresynapse`
|
|
10006
|
+
with `mssql.authType=azure-service-principal`, where the Entra principal
|
|
10007
|
+
in the iClient signs in and a `user` sent anyway is stored unused.
|
|
9999
10008
|
examples:
|
|
10000
10009
|
- integration_user
|
|
10001
10010
|
password:
|
|
@@ -10122,8 +10131,11 @@ components:
|
|
|
10122
10131
|
- keyPair
|
|
10123
10132
|
mssql:
|
|
10124
10133
|
type: object
|
|
10125
|
-
description:
|
|
10126
|
-
Microsoft SQL Server / Azure Synapse-specific configuration.
|
|
10134
|
+
description: |-
|
|
10135
|
+
Microsoft SQL Server / Azure Synapse-specific configuration. Read for
|
|
10136
|
+
both the `mssql` and the `azuresynapse` types — Azure Synapse
|
|
10137
|
+
Analytics shares SQL Server's authentication model and this
|
|
10138
|
+
sub-object.
|
|
10127
10139
|
properties:
|
|
10128
10140
|
authType:
|
|
10129
10141
|
type: string
|
|
@@ -10131,14 +10143,30 @@ components:
|
|
|
10131
10143
|
- basic
|
|
10132
10144
|
- azure-service-principal
|
|
10133
10145
|
x-enumDescriptions:
|
|
10134
|
-
basic:
|
|
10135
|
-
azure-service-principal:
|
|
10146
|
+
basic: Database user — SQL authentication with `user` and `password`
|
|
10147
|
+
azure-service-principal: Microsoft Entra service principal held in the `azureserviceprincipal` iClient referenced by `_iClientId`; `user` and `password` are not used
|
|
10136
10148
|
description: |-
|
|
10137
|
-
|
|
10138
|
-
|
|
10149
|
+
How a Microsoft SQL Server or Azure Synapse connection
|
|
10150
|
+
authenticates. Defaults to `basic` when omitted (the connection
|
|
10151
|
+
form's "Database user"). With `azure-service-principal` the
|
|
10152
|
+
connection signs in as the Entra application registered in the
|
|
10153
|
+
iClient — a client secret, or on SQL Server a certificate — and
|
|
10154
|
+
`_iClientId` must reference it. The SQL Server connection form
|
|
10155
|
+
offers `azure-service-principal` in Cloud mode only and saves
|
|
10156
|
+
`basic` for an on-premise connection (`_agentId` set).
|
|
10139
10157
|
default: basic
|
|
10140
10158
|
examples:
|
|
10141
10159
|
- basic
|
|
10160
|
+
x-celigo-ai-guidance:
|
|
10161
|
+
- |-
|
|
10162
|
+
With azure-service-principal, omit user and password: the API does not reject them —
|
|
10163
|
+
it stores them unused on the connection (live-verified 201 with both present), while
|
|
10164
|
+
the connection form removes them on save. Set them only for basic.
|
|
10165
|
+
- |-
|
|
10166
|
+
A certificate-method azureserviceprincipal iClient is offered by the form on Microsoft
|
|
10167
|
+
SQL Server connections only; the Azure Synapse form's picker lists client-secret
|
|
10168
|
+
iClients. The API accepts either on either type (live-verified 201), so follow the
|
|
10169
|
+
form: bind a certificate iClient to mssql connections only.
|
|
10142
10170
|
bigquery:
|
|
10143
10171
|
type: object
|
|
10144
10172
|
description: |
|
|
@@ -10319,10 +10347,13 @@ components:
|
|
|
10319
10347
|
x-celigo-refModel: iclients
|
|
10320
10348
|
description: |-
|
|
10321
10349
|
Reference to an iClient holding auth credentials, stored inside the
|
|
10322
|
-
rdbms object. Required when type is `mssql`
|
|
10323
|
-
`azure-service-principal` (
|
|
10324
|
-
|
|
10325
|
-
|
|
10350
|
+
rdbms object. Required when type is `mssql` or `azuresynapse` and
|
|
10351
|
+
`mssql.authType` is `azure-service-principal` (an
|
|
10352
|
+
`azureserviceprincipal` iClient — the Microsoft Entra tenant id,
|
|
10353
|
+
client id and client secret or certificate), and when type is
|
|
10354
|
+
`redshift` and `redshift.authType` is `awsIam` (an `awsIam`-provider
|
|
10355
|
+
iClient holding the role ARN to assume). On `mssql` / `azuresynapse`
|
|
10356
|
+
it is rejected when `mssql.authType` is `basic` or omitted. For
|
|
10326
10357
|
Redshift the iClient must carry `awsIam.roleArn`, and that role's name
|
|
10327
10358
|
must start with `celigo-data-warehouse-adaptor-` — the data-warehouse
|
|
10328
10359
|
service assumes only roles in that family, so a role created for an S3
|
|
@@ -10330,6 +10361,18 @@ components:
|
|
|
10330
10361
|
examples:
|
|
10331
10362
|
- 66a1b2c3d4e5f60718293a4b
|
|
10332
10363
|
x-celigo-ai-guidance:
|
|
10364
|
+
- |-
|
|
10365
|
+
For a mssql or azuresynapse connection with mssql.authType "azure-service-principal",
|
|
10366
|
+
_iClientId is required (otherwise 422 missing_required_field on rdbms._iClientId
|
|
10367
|
+
"Expected field: _iClientId to be present.") and must reference an azureserviceprincipal
|
|
10368
|
+
iClient (otherwise 422 invalid_field on rdbms._iClientId "IClient provider must be
|
|
10369
|
+
azureserviceprincipal for Service Principal authentication."). The same iClient can back
|
|
10370
|
+
Azure Data Lake Storage Gen2, SQL Server and Synapse connections.
|
|
10371
|
+
- |-
|
|
10372
|
+
With mssql.authType "basic" (or omitted) on mssql / azuresynapse, do not set _iClientId:
|
|
10373
|
+
422 invalid_field on rdbms._iClientId "The _iClientId field should not be set when using
|
|
10374
|
+
basic authentication. Remove _iClientId or switch to azure-service-principal
|
|
10375
|
+
authentication."
|
|
10333
10376
|
- |-
|
|
10334
10377
|
For a Redshift connection with redshift.authType "awsIam", the referenced iClient must
|
|
10335
10378
|
have awsIam.roleArn set (otherwise 422 missing_required_field on rdbms._iClientId
|
|
@@ -10349,7 +10392,6 @@ components:
|
|
|
10349
10392
|
- mysql
|
|
10350
10393
|
- postgresql
|
|
10351
10394
|
- mariadb
|
|
10352
|
-
- azuresynapse
|
|
10353
10395
|
required:
|
|
10354
10396
|
- type
|
|
10355
10397
|
then:
|
|
@@ -10393,120 +10435,149 @@ components:
|
|
|
10393
10435
|
if:
|
|
10394
10436
|
properties:
|
|
10395
10437
|
type:
|
|
10396
|
-
const:
|
|
10438
|
+
const: azuresynapse
|
|
10397
10439
|
required:
|
|
10398
10440
|
- type
|
|
10399
10441
|
then:
|
|
10400
|
-
required:
|
|
10401
|
-
- host
|
|
10402
|
-
- database
|
|
10403
|
-
- user
|
|
10404
|
-
properties:
|
|
10405
|
-
snowflake:
|
|
10406
|
-
required:
|
|
10407
|
-
- authType
|
|
10408
|
-
- warehouse
|
|
10409
10442
|
if:
|
|
10410
10443
|
properties:
|
|
10411
|
-
|
|
10444
|
+
mssql:
|
|
10412
10445
|
properties:
|
|
10413
10446
|
authType:
|
|
10414
|
-
const:
|
|
10447
|
+
const: azure-service-principal
|
|
10415
10448
|
required:
|
|
10416
10449
|
- authType
|
|
10417
10450
|
required:
|
|
10418
|
-
-
|
|
10451
|
+
- mssql
|
|
10419
10452
|
then:
|
|
10420
10453
|
required:
|
|
10421
|
-
-
|
|
10454
|
+
- host
|
|
10455
|
+
- database
|
|
10456
|
+
- _iClientId
|
|
10422
10457
|
else:
|
|
10423
10458
|
required:
|
|
10459
|
+
- host
|
|
10460
|
+
- database
|
|
10461
|
+
- user
|
|
10424
10462
|
- password
|
|
10425
10463
|
else:
|
|
10426
10464
|
if:
|
|
10427
10465
|
properties:
|
|
10428
10466
|
type:
|
|
10429
|
-
const:
|
|
10467
|
+
const: snowflake
|
|
10430
10468
|
required:
|
|
10431
10469
|
- type
|
|
10432
10470
|
then:
|
|
10433
10471
|
required:
|
|
10434
10472
|
- host
|
|
10473
|
+
- database
|
|
10435
10474
|
- user
|
|
10436
|
-
|
|
10475
|
+
properties:
|
|
10476
|
+
snowflake:
|
|
10477
|
+
required:
|
|
10478
|
+
- authType
|
|
10479
|
+
- warehouse
|
|
10480
|
+
if:
|
|
10481
|
+
properties:
|
|
10482
|
+
snowflake:
|
|
10483
|
+
properties:
|
|
10484
|
+
authType:
|
|
10485
|
+
const: keyPair
|
|
10486
|
+
required:
|
|
10487
|
+
- authType
|
|
10488
|
+
required:
|
|
10489
|
+
- snowflake
|
|
10490
|
+
then:
|
|
10491
|
+
required:
|
|
10492
|
+
- key
|
|
10493
|
+
else:
|
|
10494
|
+
required:
|
|
10495
|
+
- password
|
|
10437
10496
|
else:
|
|
10438
10497
|
if:
|
|
10439
10498
|
properties:
|
|
10440
10499
|
type:
|
|
10441
|
-
const:
|
|
10500
|
+
const: oracle
|
|
10442
10501
|
required:
|
|
10443
10502
|
- type
|
|
10444
10503
|
then:
|
|
10445
10504
|
required:
|
|
10446
|
-
-
|
|
10447
|
-
|
|
10448
|
-
|
|
10449
|
-
required:
|
|
10450
|
-
- projectId
|
|
10451
|
-
- dataset
|
|
10452
|
-
- clientEmail
|
|
10453
|
-
- privateKey
|
|
10505
|
+
- host
|
|
10506
|
+
- user
|
|
10507
|
+
- password
|
|
10454
10508
|
else:
|
|
10455
10509
|
if:
|
|
10456
10510
|
properties:
|
|
10457
10511
|
type:
|
|
10458
|
-
const:
|
|
10512
|
+
const: bigquery
|
|
10459
10513
|
required:
|
|
10460
10514
|
- type
|
|
10461
10515
|
then:
|
|
10462
10516
|
required:
|
|
10463
|
-
-
|
|
10464
|
-
- user
|
|
10465
|
-
- redshift
|
|
10517
|
+
- bigquery
|
|
10466
10518
|
properties:
|
|
10467
|
-
|
|
10519
|
+
bigquery:
|
|
10468
10520
|
required:
|
|
10469
|
-
-
|
|
10521
|
+
- projectId
|
|
10522
|
+
- dataset
|
|
10523
|
+
- clientEmail
|
|
10524
|
+
- privateKey
|
|
10525
|
+
else:
|
|
10470
10526
|
if:
|
|
10471
|
-
required:
|
|
10472
|
-
- redshift
|
|
10473
10527
|
properties:
|
|
10474
|
-
|
|
10475
|
-
|
|
10476
|
-
|
|
10477
|
-
|
|
10478
|
-
authType:
|
|
10479
|
-
const: awsIam
|
|
10528
|
+
type:
|
|
10529
|
+
const: redshift
|
|
10530
|
+
required:
|
|
10531
|
+
- type
|
|
10480
10532
|
then:
|
|
10481
10533
|
required:
|
|
10482
|
-
-
|
|
10483
|
-
|
|
10484
|
-
redshift
|
|
10485
|
-
oneOf:
|
|
10486
|
-
- required:
|
|
10487
|
-
- clusterIdentifier
|
|
10488
|
-
not:
|
|
10489
|
-
required:
|
|
10490
|
-
- workgroupName
|
|
10491
|
-
- required:
|
|
10492
|
-
- workgroupName
|
|
10493
|
-
not:
|
|
10494
|
-
required:
|
|
10495
|
-
- clusterIdentifier
|
|
10496
|
-
else:
|
|
10534
|
+
- database
|
|
10535
|
+
- user
|
|
10536
|
+
- redshift
|
|
10497
10537
|
properties:
|
|
10498
10538
|
redshift:
|
|
10499
10539
|
required:
|
|
10500
|
-
-
|
|
10501
|
-
|
|
10502
|
-
|
|
10540
|
+
- region
|
|
10541
|
+
if:
|
|
10542
|
+
required:
|
|
10543
|
+
- redshift
|
|
10544
|
+
properties:
|
|
10545
|
+
redshift:
|
|
10503
10546
|
required:
|
|
10504
|
-
-
|
|
10505
|
-
|
|
10506
|
-
|
|
10547
|
+
- authType
|
|
10548
|
+
properties:
|
|
10549
|
+
authType:
|
|
10550
|
+
const: awsIam
|
|
10551
|
+
then:
|
|
10552
|
+
required:
|
|
10553
|
+
- _iClientId
|
|
10554
|
+
properties:
|
|
10555
|
+
redshift:
|
|
10556
|
+
oneOf:
|
|
10557
|
+
- required:
|
|
10558
|
+
- clusterIdentifier
|
|
10559
|
+
not:
|
|
10560
|
+
required:
|
|
10561
|
+
- workgroupName
|
|
10562
|
+
- required:
|
|
10563
|
+
- workgroupName
|
|
10564
|
+
not:
|
|
10565
|
+
required:
|
|
10566
|
+
- clusterIdentifier
|
|
10567
|
+
else:
|
|
10568
|
+
properties:
|
|
10569
|
+
redshift:
|
|
10570
|
+
required:
|
|
10571
|
+
- aws
|
|
10572
|
+
- clusterIdentifier
|
|
10573
|
+
not:
|
|
10507
10574
|
required:
|
|
10508
|
-
-
|
|
10509
|
-
|
|
10575
|
+
- workgroupName
|
|
10576
|
+
properties:
|
|
10577
|
+
aws:
|
|
10578
|
+
required:
|
|
10579
|
+
- accessKeyId
|
|
10580
|
+
- secretAccessKey
|
|
10510
10581
|
MongoDB:
|
|
10511
10582
|
type: object
|
|
10512
10583
|
description: |-
|
package/package.json
CHANGED