@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/mcp-server.yml
CHANGED
|
@@ -6551,11 +6551,12 @@ components:
|
|
|
6551
6551
|
- `database` — required for every type EXCEPT `oracle` (uses `serviceName`)
|
|
6552
6552
|
and `bigquery` (uses `bigquery.dataset`).
|
|
6553
6553
|
- `user` — required for every type EXCEPT `bigquery`, `redshift`, and
|
|
6554
|
-
`mssql` with `mssql.authType=azure-service-principal`.
|
|
6554
|
+
`mssql` / `azuresynapse` with `mssql.authType=azure-service-principal`.
|
|
6555
6555
|
- `password` — required when no SSL cert material is provided AND the
|
|
6556
|
-
type is NOT `bigquery`, `redshift`, `snowflake`, or `mssql`
|
|
6557
|
-
`azure-service-principal` auth. When SSL cert
|
|
6558
|
-
without a password, both `ssl.key` and `ssl.cert`
|
|
6556
|
+
type is NOT `bigquery`, `redshift`, `snowflake`, or `mssql` /
|
|
6557
|
+
`azuresynapse` with `azure-service-principal` auth. When SSL cert
|
|
6558
|
+
material IS provided without a password, both `ssl.key` and `ssl.cert`
|
|
6559
|
+
become required.
|
|
6559
6560
|
- **Snowflake** — additionally requires `snowflake.warehouse` and
|
|
6560
6561
|
`snowflake.authType`. When `snowflake.authType=keyPair`, also
|
|
6561
6562
|
requires the `key` field at the rdbms level (the RSA private key).
|
|
@@ -6571,8 +6572,14 @@ components:
|
|
|
6571
6572
|
iClient holding the role ARN) plus exactly one of
|
|
6572
6573
|
`redshift.clusterIdentifier` (provisioned cluster) or
|
|
6573
6574
|
`redshift.workgroupName` (Redshift Serverless).
|
|
6574
|
-
- **MSSQL with `mssql.authType=azure-service-principal`**
|
|
6575
|
-
`_iClientId`
|
|
6575
|
+
- **MSSQL / Azure Synapse with `mssql.authType=azure-service-principal`**
|
|
6576
|
+
— requires `_iClientId` referencing an `azureserviceprincipal` iClient
|
|
6577
|
+
(the Microsoft Entra tenant id, client id and client secret or
|
|
6578
|
+
certificate live in the iClient); `user` and `password` are not used.
|
|
6579
|
+
`_iClientId` with `basic` auth is rejected. Both types share the
|
|
6580
|
+
`mssql` sub-object; `azuresynapse` is cloud-only, and the SQL Server
|
|
6581
|
+
connection form offers service-principal auth in Cloud mode only — it
|
|
6582
|
+
saves `basic` for an on-premise connection (`_agentId` set).
|
|
6576
6583
|
- **Oracle** — runs in agent mode only, so requires `_agentId` on the
|
|
6577
6584
|
parent connection object. Uses `serviceName` instead of `database`.
|
|
6578
6585
|
Optionally also takes `serverType` and `instanceName`.
|
|
@@ -6665,8 +6672,10 @@ components:
|
|
|
6665
6672
|
user:
|
|
6666
6673
|
type: string
|
|
6667
6674
|
description: |
|
|
6668
|
-
Database username for authentication.
|
|
6669
|
-
|
|
6675
|
+
Database username for authentication. Required for all types except
|
|
6676
|
+
BigQuery (service account auth), Redshift, and `mssql` / `azuresynapse`
|
|
6677
|
+
with `mssql.authType=azure-service-principal`, where the Entra principal
|
|
6678
|
+
in the iClient signs in and a `user` sent anyway is stored unused.
|
|
6670
6679
|
examples:
|
|
6671
6680
|
- integration_user
|
|
6672
6681
|
password:
|
|
@@ -6793,8 +6802,11 @@ components:
|
|
|
6793
6802
|
- keyPair
|
|
6794
6803
|
mssql:
|
|
6795
6804
|
type: object
|
|
6796
|
-
description:
|
|
6797
|
-
Microsoft SQL Server / Azure Synapse-specific configuration.
|
|
6805
|
+
description: |-
|
|
6806
|
+
Microsoft SQL Server / Azure Synapse-specific configuration. Read for
|
|
6807
|
+
both the `mssql` and the `azuresynapse` types — Azure Synapse
|
|
6808
|
+
Analytics shares SQL Server's authentication model and this
|
|
6809
|
+
sub-object.
|
|
6798
6810
|
properties:
|
|
6799
6811
|
authType:
|
|
6800
6812
|
type: string
|
|
@@ -6802,14 +6814,30 @@ components:
|
|
|
6802
6814
|
- basic
|
|
6803
6815
|
- azure-service-principal
|
|
6804
6816
|
x-enumDescriptions:
|
|
6805
|
-
basic:
|
|
6806
|
-
azure-service-principal:
|
|
6817
|
+
basic: Database user — SQL authentication with `user` and `password`
|
|
6818
|
+
azure-service-principal: Microsoft Entra service principal held in the `azureserviceprincipal` iClient referenced by `_iClientId`; `user` and `password` are not used
|
|
6807
6819
|
description: |-
|
|
6808
|
-
|
|
6809
|
-
|
|
6820
|
+
How a Microsoft SQL Server or Azure Synapse connection
|
|
6821
|
+
authenticates. Defaults to `basic` when omitted (the connection
|
|
6822
|
+
form's "Database user"). With `azure-service-principal` the
|
|
6823
|
+
connection signs in as the Entra application registered in the
|
|
6824
|
+
iClient — a client secret, or on SQL Server a certificate — and
|
|
6825
|
+
`_iClientId` must reference it. The SQL Server connection form
|
|
6826
|
+
offers `azure-service-principal` in Cloud mode only and saves
|
|
6827
|
+
`basic` for an on-premise connection (`_agentId` set).
|
|
6810
6828
|
default: basic
|
|
6811
6829
|
examples:
|
|
6812
6830
|
- basic
|
|
6831
|
+
x-celigo-ai-guidance:
|
|
6832
|
+
- |-
|
|
6833
|
+
With azure-service-principal, omit user and password: the API does not reject them —
|
|
6834
|
+
it stores them unused on the connection (live-verified 201 with both present), while
|
|
6835
|
+
the connection form removes them on save. Set them only for basic.
|
|
6836
|
+
- |-
|
|
6837
|
+
A certificate-method azureserviceprincipal iClient is offered by the form on Microsoft
|
|
6838
|
+
SQL Server connections only; the Azure Synapse form's picker lists client-secret
|
|
6839
|
+
iClients. The API accepts either on either type (live-verified 201), so follow the
|
|
6840
|
+
form: bind a certificate iClient to mssql connections only.
|
|
6813
6841
|
bigquery:
|
|
6814
6842
|
type: object
|
|
6815
6843
|
description: |
|
|
@@ -6990,10 +7018,13 @@ components:
|
|
|
6990
7018
|
x-celigo-refModel: iclients
|
|
6991
7019
|
description: |-
|
|
6992
7020
|
Reference to an iClient holding auth credentials, stored inside the
|
|
6993
|
-
rdbms object. Required when type is `mssql`
|
|
6994
|
-
`azure-service-principal` (
|
|
6995
|
-
|
|
6996
|
-
|
|
7021
|
+
rdbms object. Required when type is `mssql` or `azuresynapse` and
|
|
7022
|
+
`mssql.authType` is `azure-service-principal` (an
|
|
7023
|
+
`azureserviceprincipal` iClient — the Microsoft Entra tenant id,
|
|
7024
|
+
client id and client secret or certificate), and when type is
|
|
7025
|
+
`redshift` and `redshift.authType` is `awsIam` (an `awsIam`-provider
|
|
7026
|
+
iClient holding the role ARN to assume). On `mssql` / `azuresynapse`
|
|
7027
|
+
it is rejected when `mssql.authType` is `basic` or omitted. For
|
|
6997
7028
|
Redshift the iClient must carry `awsIam.roleArn`, and that role's name
|
|
6998
7029
|
must start with `celigo-data-warehouse-adaptor-` — the data-warehouse
|
|
6999
7030
|
service assumes only roles in that family, so a role created for an S3
|
|
@@ -7001,6 +7032,18 @@ components:
|
|
|
7001
7032
|
examples:
|
|
7002
7033
|
- 66a1b2c3d4e5f60718293a4b
|
|
7003
7034
|
x-celigo-ai-guidance:
|
|
7035
|
+
- |-
|
|
7036
|
+
For a mssql or azuresynapse connection with mssql.authType "azure-service-principal",
|
|
7037
|
+
_iClientId is required (otherwise 422 missing_required_field on rdbms._iClientId
|
|
7038
|
+
"Expected field: _iClientId to be present.") and must reference an azureserviceprincipal
|
|
7039
|
+
iClient (otherwise 422 invalid_field on rdbms._iClientId "IClient provider must be
|
|
7040
|
+
azureserviceprincipal for Service Principal authentication."). The same iClient can back
|
|
7041
|
+
Azure Data Lake Storage Gen2, SQL Server and Synapse connections.
|
|
7042
|
+
- |-
|
|
7043
|
+
With mssql.authType "basic" (or omitted) on mssql / azuresynapse, do not set _iClientId:
|
|
7044
|
+
422 invalid_field on rdbms._iClientId "The _iClientId field should not be set when using
|
|
7045
|
+
basic authentication. Remove _iClientId or switch to azure-service-principal
|
|
7046
|
+
authentication."
|
|
7004
7047
|
- |-
|
|
7005
7048
|
For a Redshift connection with redshift.authType "awsIam", the referenced iClient must
|
|
7006
7049
|
have awsIam.roleArn set (otherwise 422 missing_required_field on rdbms._iClientId
|
|
@@ -7020,7 +7063,6 @@ components:
|
|
|
7020
7063
|
- mysql
|
|
7021
7064
|
- postgresql
|
|
7022
7065
|
- mariadb
|
|
7023
|
-
- azuresynapse
|
|
7024
7066
|
required:
|
|
7025
7067
|
- type
|
|
7026
7068
|
then:
|
|
@@ -7064,120 +7106,149 @@ components:
|
|
|
7064
7106
|
if:
|
|
7065
7107
|
properties:
|
|
7066
7108
|
type:
|
|
7067
|
-
const:
|
|
7109
|
+
const: azuresynapse
|
|
7068
7110
|
required:
|
|
7069
7111
|
- type
|
|
7070
7112
|
then:
|
|
7071
|
-
required:
|
|
7072
|
-
- host
|
|
7073
|
-
- database
|
|
7074
|
-
- user
|
|
7075
|
-
properties:
|
|
7076
|
-
snowflake:
|
|
7077
|
-
required:
|
|
7078
|
-
- authType
|
|
7079
|
-
- warehouse
|
|
7080
7113
|
if:
|
|
7081
7114
|
properties:
|
|
7082
|
-
|
|
7115
|
+
mssql:
|
|
7083
7116
|
properties:
|
|
7084
7117
|
authType:
|
|
7085
|
-
const:
|
|
7118
|
+
const: azure-service-principal
|
|
7086
7119
|
required:
|
|
7087
7120
|
- authType
|
|
7088
7121
|
required:
|
|
7089
|
-
-
|
|
7122
|
+
- mssql
|
|
7090
7123
|
then:
|
|
7091
7124
|
required:
|
|
7092
|
-
-
|
|
7125
|
+
- host
|
|
7126
|
+
- database
|
|
7127
|
+
- _iClientId
|
|
7093
7128
|
else:
|
|
7094
7129
|
required:
|
|
7130
|
+
- host
|
|
7131
|
+
- database
|
|
7132
|
+
- user
|
|
7095
7133
|
- password
|
|
7096
7134
|
else:
|
|
7097
7135
|
if:
|
|
7098
7136
|
properties:
|
|
7099
7137
|
type:
|
|
7100
|
-
const:
|
|
7138
|
+
const: snowflake
|
|
7101
7139
|
required:
|
|
7102
7140
|
- type
|
|
7103
7141
|
then:
|
|
7104
7142
|
required:
|
|
7105
7143
|
- host
|
|
7144
|
+
- database
|
|
7106
7145
|
- user
|
|
7107
|
-
|
|
7146
|
+
properties:
|
|
7147
|
+
snowflake:
|
|
7148
|
+
required:
|
|
7149
|
+
- authType
|
|
7150
|
+
- warehouse
|
|
7151
|
+
if:
|
|
7152
|
+
properties:
|
|
7153
|
+
snowflake:
|
|
7154
|
+
properties:
|
|
7155
|
+
authType:
|
|
7156
|
+
const: keyPair
|
|
7157
|
+
required:
|
|
7158
|
+
- authType
|
|
7159
|
+
required:
|
|
7160
|
+
- snowflake
|
|
7161
|
+
then:
|
|
7162
|
+
required:
|
|
7163
|
+
- key
|
|
7164
|
+
else:
|
|
7165
|
+
required:
|
|
7166
|
+
- password
|
|
7108
7167
|
else:
|
|
7109
7168
|
if:
|
|
7110
7169
|
properties:
|
|
7111
7170
|
type:
|
|
7112
|
-
const:
|
|
7171
|
+
const: oracle
|
|
7113
7172
|
required:
|
|
7114
7173
|
- type
|
|
7115
7174
|
then:
|
|
7116
7175
|
required:
|
|
7117
|
-
-
|
|
7118
|
-
|
|
7119
|
-
|
|
7120
|
-
required:
|
|
7121
|
-
- projectId
|
|
7122
|
-
- dataset
|
|
7123
|
-
- clientEmail
|
|
7124
|
-
- privateKey
|
|
7176
|
+
- host
|
|
7177
|
+
- user
|
|
7178
|
+
- password
|
|
7125
7179
|
else:
|
|
7126
7180
|
if:
|
|
7127
7181
|
properties:
|
|
7128
7182
|
type:
|
|
7129
|
-
const:
|
|
7183
|
+
const: bigquery
|
|
7130
7184
|
required:
|
|
7131
7185
|
- type
|
|
7132
7186
|
then:
|
|
7133
7187
|
required:
|
|
7134
|
-
-
|
|
7135
|
-
- user
|
|
7136
|
-
- redshift
|
|
7188
|
+
- bigquery
|
|
7137
7189
|
properties:
|
|
7138
|
-
|
|
7190
|
+
bigquery:
|
|
7139
7191
|
required:
|
|
7140
|
-
-
|
|
7192
|
+
- projectId
|
|
7193
|
+
- dataset
|
|
7194
|
+
- clientEmail
|
|
7195
|
+
- privateKey
|
|
7196
|
+
else:
|
|
7141
7197
|
if:
|
|
7142
|
-
required:
|
|
7143
|
-
- redshift
|
|
7144
7198
|
properties:
|
|
7145
|
-
|
|
7146
|
-
|
|
7147
|
-
|
|
7148
|
-
|
|
7149
|
-
authType:
|
|
7150
|
-
const: awsIam
|
|
7199
|
+
type:
|
|
7200
|
+
const: redshift
|
|
7201
|
+
required:
|
|
7202
|
+
- type
|
|
7151
7203
|
then:
|
|
7152
7204
|
required:
|
|
7153
|
-
-
|
|
7154
|
-
|
|
7155
|
-
redshift
|
|
7156
|
-
oneOf:
|
|
7157
|
-
- required:
|
|
7158
|
-
- clusterIdentifier
|
|
7159
|
-
not:
|
|
7160
|
-
required:
|
|
7161
|
-
- workgroupName
|
|
7162
|
-
- required:
|
|
7163
|
-
- workgroupName
|
|
7164
|
-
not:
|
|
7165
|
-
required:
|
|
7166
|
-
- clusterIdentifier
|
|
7167
|
-
else:
|
|
7205
|
+
- database
|
|
7206
|
+
- user
|
|
7207
|
+
- redshift
|
|
7168
7208
|
properties:
|
|
7169
7209
|
redshift:
|
|
7170
7210
|
required:
|
|
7171
|
-
-
|
|
7172
|
-
|
|
7173
|
-
|
|
7211
|
+
- region
|
|
7212
|
+
if:
|
|
7213
|
+
required:
|
|
7214
|
+
- redshift
|
|
7215
|
+
properties:
|
|
7216
|
+
redshift:
|
|
7174
7217
|
required:
|
|
7175
|
-
-
|
|
7176
|
-
|
|
7177
|
-
|
|
7218
|
+
- authType
|
|
7219
|
+
properties:
|
|
7220
|
+
authType:
|
|
7221
|
+
const: awsIam
|
|
7222
|
+
then:
|
|
7223
|
+
required:
|
|
7224
|
+
- _iClientId
|
|
7225
|
+
properties:
|
|
7226
|
+
redshift:
|
|
7227
|
+
oneOf:
|
|
7228
|
+
- required:
|
|
7229
|
+
- clusterIdentifier
|
|
7230
|
+
not:
|
|
7231
|
+
required:
|
|
7232
|
+
- workgroupName
|
|
7233
|
+
- required:
|
|
7234
|
+
- workgroupName
|
|
7235
|
+
not:
|
|
7236
|
+
required:
|
|
7237
|
+
- clusterIdentifier
|
|
7238
|
+
else:
|
|
7239
|
+
properties:
|
|
7240
|
+
redshift:
|
|
7241
|
+
required:
|
|
7242
|
+
- aws
|
|
7243
|
+
- clusterIdentifier
|
|
7244
|
+
not:
|
|
7178
7245
|
required:
|
|
7179
|
-
-
|
|
7180
|
-
|
|
7246
|
+
- workgroupName
|
|
7247
|
+
properties:
|
|
7248
|
+
aws:
|
|
7249
|
+
required:
|
|
7250
|
+
- accessKeyId
|
|
7251
|
+
- secretAccessKey
|
|
7181
7252
|
MongoDB:
|
|
7182
7253
|
type: object
|
|
7183
7254
|
description: |-
|