@celigo/api-specs 0.2.102 → 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/connection.yml
CHANGED
|
@@ -6087,11 +6087,12 @@ components:
|
|
|
6087
6087
|
- `database` — required for every type EXCEPT `oracle` (uses `serviceName`)
|
|
6088
6088
|
and `bigquery` (uses `bigquery.dataset`).
|
|
6089
6089
|
- `user` — required for every type EXCEPT `bigquery`, `redshift`, and
|
|
6090
|
-
`mssql` with `mssql.authType=azure-service-principal`.
|
|
6090
|
+
`mssql` / `azuresynapse` with `mssql.authType=azure-service-principal`.
|
|
6091
6091
|
- `password` — required when no SSL cert material is provided AND the
|
|
6092
|
-
type is NOT `bigquery`, `redshift`, `snowflake`, or `mssql`
|
|
6093
|
-
`azure-service-principal` auth. When SSL cert
|
|
6094
|
-
without a password, both `ssl.key` and `ssl.cert`
|
|
6092
|
+
type is NOT `bigquery`, `redshift`, `snowflake`, or `mssql` /
|
|
6093
|
+
`azuresynapse` with `azure-service-principal` auth. When SSL cert
|
|
6094
|
+
material IS provided without a password, both `ssl.key` and `ssl.cert`
|
|
6095
|
+
become required.
|
|
6095
6096
|
- **Snowflake** — additionally requires `snowflake.warehouse` and
|
|
6096
6097
|
`snowflake.authType`. When `snowflake.authType=keyPair`, also
|
|
6097
6098
|
requires the `key` field at the rdbms level (the RSA private key).
|
|
@@ -6107,8 +6108,14 @@ components:
|
|
|
6107
6108
|
iClient holding the role ARN) plus exactly one of
|
|
6108
6109
|
`redshift.clusterIdentifier` (provisioned cluster) or
|
|
6109
6110
|
`redshift.workgroupName` (Redshift Serverless).
|
|
6110
|
-
- **MSSQL with `mssql.authType=azure-service-principal`**
|
|
6111
|
-
`_iClientId`
|
|
6111
|
+
- **MSSQL / Azure Synapse with `mssql.authType=azure-service-principal`**
|
|
6112
|
+
— requires `_iClientId` referencing an `azureserviceprincipal` iClient
|
|
6113
|
+
(the Microsoft Entra tenant id, client id and client secret or
|
|
6114
|
+
certificate live in the iClient); `user` and `password` are not used.
|
|
6115
|
+
`_iClientId` with `basic` auth is rejected. Both types share the
|
|
6116
|
+
`mssql` sub-object; `azuresynapse` is cloud-only, and the SQL Server
|
|
6117
|
+
connection form offers service-principal auth in Cloud mode only — it
|
|
6118
|
+
saves `basic` for an on-premise connection (`_agentId` set).
|
|
6112
6119
|
- **Oracle** — runs in agent mode only, so requires `_agentId` on the
|
|
6113
6120
|
parent connection object. Uses `serviceName` instead of `database`.
|
|
6114
6121
|
Optionally also takes `serverType` and `instanceName`.
|
|
@@ -6201,8 +6208,10 @@ components:
|
|
|
6201
6208
|
user:
|
|
6202
6209
|
type: string
|
|
6203
6210
|
description: |
|
|
6204
|
-
Database username for authentication.
|
|
6205
|
-
|
|
6211
|
+
Database username for authentication. Required for all types except
|
|
6212
|
+
BigQuery (service account auth), Redshift, and `mssql` / `azuresynapse`
|
|
6213
|
+
with `mssql.authType=azure-service-principal`, where the Entra principal
|
|
6214
|
+
in the iClient signs in and a `user` sent anyway is stored unused.
|
|
6206
6215
|
examples:
|
|
6207
6216
|
- integration_user
|
|
6208
6217
|
password:
|
|
@@ -6329,8 +6338,11 @@ components:
|
|
|
6329
6338
|
- keyPair
|
|
6330
6339
|
mssql:
|
|
6331
6340
|
type: object
|
|
6332
|
-
description:
|
|
6333
|
-
Microsoft SQL Server / Azure Synapse-specific configuration.
|
|
6341
|
+
description: |-
|
|
6342
|
+
Microsoft SQL Server / Azure Synapse-specific configuration. Read for
|
|
6343
|
+
both the `mssql` and the `azuresynapse` types — Azure Synapse
|
|
6344
|
+
Analytics shares SQL Server's authentication model and this
|
|
6345
|
+
sub-object.
|
|
6334
6346
|
properties:
|
|
6335
6347
|
authType:
|
|
6336
6348
|
type: string
|
|
@@ -6338,14 +6350,30 @@ components:
|
|
|
6338
6350
|
- basic
|
|
6339
6351
|
- azure-service-principal
|
|
6340
6352
|
x-enumDescriptions:
|
|
6341
|
-
basic:
|
|
6342
|
-
azure-service-principal:
|
|
6353
|
+
basic: Database user — SQL authentication with `user` and `password`
|
|
6354
|
+
azure-service-principal: Microsoft Entra service principal held in the `azureserviceprincipal` iClient referenced by `_iClientId`; `user` and `password` are not used
|
|
6343
6355
|
description: |-
|
|
6344
|
-
|
|
6345
|
-
|
|
6356
|
+
How a Microsoft SQL Server or Azure Synapse connection
|
|
6357
|
+
authenticates. Defaults to `basic` when omitted (the connection
|
|
6358
|
+
form's "Database user"). With `azure-service-principal` the
|
|
6359
|
+
connection signs in as the Entra application registered in the
|
|
6360
|
+
iClient — a client secret, or on SQL Server a certificate — and
|
|
6361
|
+
`_iClientId` must reference it. The SQL Server connection form
|
|
6362
|
+
offers `azure-service-principal` in Cloud mode only and saves
|
|
6363
|
+
`basic` for an on-premise connection (`_agentId` set).
|
|
6346
6364
|
default: basic
|
|
6347
6365
|
examples:
|
|
6348
6366
|
- basic
|
|
6367
|
+
x-celigo-ai-guidance:
|
|
6368
|
+
- |-
|
|
6369
|
+
With azure-service-principal, omit user and password: the API does not reject them —
|
|
6370
|
+
it stores them unused on the connection (live-verified 201 with both present), while
|
|
6371
|
+
the connection form removes them on save. Set them only for basic.
|
|
6372
|
+
- |-
|
|
6373
|
+
A certificate-method azureserviceprincipal iClient is offered by the form on Microsoft
|
|
6374
|
+
SQL Server connections only; the Azure Synapse form's picker lists client-secret
|
|
6375
|
+
iClients. The API accepts either on either type (live-verified 201), so follow the
|
|
6376
|
+
form: bind a certificate iClient to mssql connections only.
|
|
6349
6377
|
bigquery:
|
|
6350
6378
|
type: object
|
|
6351
6379
|
description: |
|
|
@@ -6526,10 +6554,13 @@ components:
|
|
|
6526
6554
|
x-celigo-refModel: iclients
|
|
6527
6555
|
description: |-
|
|
6528
6556
|
Reference to an iClient holding auth credentials, stored inside the
|
|
6529
|
-
rdbms object. Required when type is `mssql`
|
|
6530
|
-
`azure-service-principal` (
|
|
6531
|
-
|
|
6532
|
-
|
|
6557
|
+
rdbms object. Required when type is `mssql` or `azuresynapse` and
|
|
6558
|
+
`mssql.authType` is `azure-service-principal` (an
|
|
6559
|
+
`azureserviceprincipal` iClient — the Microsoft Entra tenant id,
|
|
6560
|
+
client id and client secret or certificate), and when type is
|
|
6561
|
+
`redshift` and `redshift.authType` is `awsIam` (an `awsIam`-provider
|
|
6562
|
+
iClient holding the role ARN to assume). On `mssql` / `azuresynapse`
|
|
6563
|
+
it is rejected when `mssql.authType` is `basic` or omitted. For
|
|
6533
6564
|
Redshift the iClient must carry `awsIam.roleArn`, and that role's name
|
|
6534
6565
|
must start with `celigo-data-warehouse-adaptor-` — the data-warehouse
|
|
6535
6566
|
service assumes only roles in that family, so a role created for an S3
|
|
@@ -6537,6 +6568,18 @@ components:
|
|
|
6537
6568
|
examples:
|
|
6538
6569
|
- 66a1b2c3d4e5f60718293a4b
|
|
6539
6570
|
x-celigo-ai-guidance:
|
|
6571
|
+
- |-
|
|
6572
|
+
For a mssql or azuresynapse connection with mssql.authType "azure-service-principal",
|
|
6573
|
+
_iClientId is required (otherwise 422 missing_required_field on rdbms._iClientId
|
|
6574
|
+
"Expected field: _iClientId to be present.") and must reference an azureserviceprincipal
|
|
6575
|
+
iClient (otherwise 422 invalid_field on rdbms._iClientId "IClient provider must be
|
|
6576
|
+
azureserviceprincipal for Service Principal authentication."). The same iClient can back
|
|
6577
|
+
Azure Data Lake Storage Gen2, SQL Server and Synapse connections.
|
|
6578
|
+
- |-
|
|
6579
|
+
With mssql.authType "basic" (or omitted) on mssql / azuresynapse, do not set _iClientId:
|
|
6580
|
+
422 invalid_field on rdbms._iClientId "The _iClientId field should not be set when using
|
|
6581
|
+
basic authentication. Remove _iClientId or switch to azure-service-principal
|
|
6582
|
+
authentication."
|
|
6540
6583
|
- |-
|
|
6541
6584
|
For a Redshift connection with redshift.authType "awsIam", the referenced iClient must
|
|
6542
6585
|
have awsIam.roleArn set (otherwise 422 missing_required_field on rdbms._iClientId
|
|
@@ -6556,7 +6599,6 @@ components:
|
|
|
6556
6599
|
- mysql
|
|
6557
6600
|
- postgresql
|
|
6558
6601
|
- mariadb
|
|
6559
|
-
- azuresynapse
|
|
6560
6602
|
required:
|
|
6561
6603
|
- type
|
|
6562
6604
|
then:
|
|
@@ -6600,120 +6642,149 @@ components:
|
|
|
6600
6642
|
if:
|
|
6601
6643
|
properties:
|
|
6602
6644
|
type:
|
|
6603
|
-
const:
|
|
6645
|
+
const: azuresynapse
|
|
6604
6646
|
required:
|
|
6605
6647
|
- type
|
|
6606
6648
|
then:
|
|
6607
|
-
required:
|
|
6608
|
-
- host
|
|
6609
|
-
- database
|
|
6610
|
-
- user
|
|
6611
|
-
properties:
|
|
6612
|
-
snowflake:
|
|
6613
|
-
required:
|
|
6614
|
-
- authType
|
|
6615
|
-
- warehouse
|
|
6616
6649
|
if:
|
|
6617
6650
|
properties:
|
|
6618
|
-
|
|
6651
|
+
mssql:
|
|
6619
6652
|
properties:
|
|
6620
6653
|
authType:
|
|
6621
|
-
const:
|
|
6654
|
+
const: azure-service-principal
|
|
6622
6655
|
required:
|
|
6623
6656
|
- authType
|
|
6624
6657
|
required:
|
|
6625
|
-
-
|
|
6658
|
+
- mssql
|
|
6626
6659
|
then:
|
|
6627
6660
|
required:
|
|
6628
|
-
-
|
|
6661
|
+
- host
|
|
6662
|
+
- database
|
|
6663
|
+
- _iClientId
|
|
6629
6664
|
else:
|
|
6630
6665
|
required:
|
|
6666
|
+
- host
|
|
6667
|
+
- database
|
|
6668
|
+
- user
|
|
6631
6669
|
- password
|
|
6632
6670
|
else:
|
|
6633
6671
|
if:
|
|
6634
6672
|
properties:
|
|
6635
6673
|
type:
|
|
6636
|
-
const:
|
|
6674
|
+
const: snowflake
|
|
6637
6675
|
required:
|
|
6638
6676
|
- type
|
|
6639
6677
|
then:
|
|
6640
6678
|
required:
|
|
6641
6679
|
- host
|
|
6680
|
+
- database
|
|
6642
6681
|
- user
|
|
6643
|
-
|
|
6682
|
+
properties:
|
|
6683
|
+
snowflake:
|
|
6684
|
+
required:
|
|
6685
|
+
- authType
|
|
6686
|
+
- warehouse
|
|
6687
|
+
if:
|
|
6688
|
+
properties:
|
|
6689
|
+
snowflake:
|
|
6690
|
+
properties:
|
|
6691
|
+
authType:
|
|
6692
|
+
const: keyPair
|
|
6693
|
+
required:
|
|
6694
|
+
- authType
|
|
6695
|
+
required:
|
|
6696
|
+
- snowflake
|
|
6697
|
+
then:
|
|
6698
|
+
required:
|
|
6699
|
+
- key
|
|
6700
|
+
else:
|
|
6701
|
+
required:
|
|
6702
|
+
- password
|
|
6644
6703
|
else:
|
|
6645
6704
|
if:
|
|
6646
6705
|
properties:
|
|
6647
6706
|
type:
|
|
6648
|
-
const:
|
|
6707
|
+
const: oracle
|
|
6649
6708
|
required:
|
|
6650
6709
|
- type
|
|
6651
6710
|
then:
|
|
6652
6711
|
required:
|
|
6653
|
-
-
|
|
6654
|
-
|
|
6655
|
-
|
|
6656
|
-
required:
|
|
6657
|
-
- projectId
|
|
6658
|
-
- dataset
|
|
6659
|
-
- clientEmail
|
|
6660
|
-
- privateKey
|
|
6712
|
+
- host
|
|
6713
|
+
- user
|
|
6714
|
+
- password
|
|
6661
6715
|
else:
|
|
6662
6716
|
if:
|
|
6663
6717
|
properties:
|
|
6664
6718
|
type:
|
|
6665
|
-
const:
|
|
6719
|
+
const: bigquery
|
|
6666
6720
|
required:
|
|
6667
6721
|
- type
|
|
6668
6722
|
then:
|
|
6669
6723
|
required:
|
|
6670
|
-
-
|
|
6671
|
-
- user
|
|
6672
|
-
- redshift
|
|
6724
|
+
- bigquery
|
|
6673
6725
|
properties:
|
|
6674
|
-
|
|
6726
|
+
bigquery:
|
|
6675
6727
|
required:
|
|
6676
|
-
-
|
|
6728
|
+
- projectId
|
|
6729
|
+
- dataset
|
|
6730
|
+
- clientEmail
|
|
6731
|
+
- privateKey
|
|
6732
|
+
else:
|
|
6677
6733
|
if:
|
|
6678
|
-
required:
|
|
6679
|
-
- redshift
|
|
6680
6734
|
properties:
|
|
6681
|
-
|
|
6682
|
-
|
|
6683
|
-
|
|
6684
|
-
|
|
6685
|
-
authType:
|
|
6686
|
-
const: awsIam
|
|
6735
|
+
type:
|
|
6736
|
+
const: redshift
|
|
6737
|
+
required:
|
|
6738
|
+
- type
|
|
6687
6739
|
then:
|
|
6688
6740
|
required:
|
|
6689
|
-
-
|
|
6690
|
-
|
|
6691
|
-
redshift
|
|
6692
|
-
oneOf:
|
|
6693
|
-
- required:
|
|
6694
|
-
- clusterIdentifier
|
|
6695
|
-
not:
|
|
6696
|
-
required:
|
|
6697
|
-
- workgroupName
|
|
6698
|
-
- required:
|
|
6699
|
-
- workgroupName
|
|
6700
|
-
not:
|
|
6701
|
-
required:
|
|
6702
|
-
- clusterIdentifier
|
|
6703
|
-
else:
|
|
6741
|
+
- database
|
|
6742
|
+
- user
|
|
6743
|
+
- redshift
|
|
6704
6744
|
properties:
|
|
6705
6745
|
redshift:
|
|
6706
6746
|
required:
|
|
6707
|
-
-
|
|
6708
|
-
|
|
6709
|
-
|
|
6747
|
+
- region
|
|
6748
|
+
if:
|
|
6749
|
+
required:
|
|
6750
|
+
- redshift
|
|
6751
|
+
properties:
|
|
6752
|
+
redshift:
|
|
6710
6753
|
required:
|
|
6711
|
-
-
|
|
6712
|
-
|
|
6713
|
-
|
|
6754
|
+
- authType
|
|
6755
|
+
properties:
|
|
6756
|
+
authType:
|
|
6757
|
+
const: awsIam
|
|
6758
|
+
then:
|
|
6759
|
+
required:
|
|
6760
|
+
- _iClientId
|
|
6761
|
+
properties:
|
|
6762
|
+
redshift:
|
|
6763
|
+
oneOf:
|
|
6764
|
+
- required:
|
|
6765
|
+
- clusterIdentifier
|
|
6766
|
+
not:
|
|
6767
|
+
required:
|
|
6768
|
+
- workgroupName
|
|
6769
|
+
- required:
|
|
6770
|
+
- workgroupName
|
|
6771
|
+
not:
|
|
6772
|
+
required:
|
|
6773
|
+
- clusterIdentifier
|
|
6774
|
+
else:
|
|
6775
|
+
properties:
|
|
6776
|
+
redshift:
|
|
6777
|
+
required:
|
|
6778
|
+
- aws
|
|
6779
|
+
- clusterIdentifier
|
|
6780
|
+
not:
|
|
6714
6781
|
required:
|
|
6715
|
-
-
|
|
6716
|
-
|
|
6782
|
+
- workgroupName
|
|
6783
|
+
properties:
|
|
6784
|
+
aws:
|
|
6785
|
+
required:
|
|
6786
|
+
- accessKeyId
|
|
6787
|
+
- secretAccessKey
|
|
6717
6788
|
MongoDB:
|
|
6718
6789
|
type: object
|
|
6719
6790
|
description: |-
|