@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/api.yml
CHANGED
|
@@ -7514,11 +7514,12 @@ components:
|
|
|
7514
7514
|
- `database` — required for every type EXCEPT `oracle` (uses `serviceName`)
|
|
7515
7515
|
and `bigquery` (uses `bigquery.dataset`).
|
|
7516
7516
|
- `user` — required for every type EXCEPT `bigquery`, `redshift`, and
|
|
7517
|
-
`mssql` with `mssql.authType=azure-service-principal`.
|
|
7517
|
+
`mssql` / `azuresynapse` with `mssql.authType=azure-service-principal`.
|
|
7518
7518
|
- `password` — required when no SSL cert material is provided AND the
|
|
7519
|
-
type is NOT `bigquery`, `redshift`, `snowflake`, or `mssql`
|
|
7520
|
-
`azure-service-principal` auth. When SSL cert
|
|
7521
|
-
without a password, both `ssl.key` and `ssl.cert`
|
|
7519
|
+
type is NOT `bigquery`, `redshift`, `snowflake`, or `mssql` /
|
|
7520
|
+
`azuresynapse` with `azure-service-principal` auth. When SSL cert
|
|
7521
|
+
material IS provided without a password, both `ssl.key` and `ssl.cert`
|
|
7522
|
+
become required.
|
|
7522
7523
|
- **Snowflake** — additionally requires `snowflake.warehouse` and
|
|
7523
7524
|
`snowflake.authType`. When `snowflake.authType=keyPair`, also
|
|
7524
7525
|
requires the `key` field at the rdbms level (the RSA private key).
|
|
@@ -7534,8 +7535,14 @@ components:
|
|
|
7534
7535
|
iClient holding the role ARN) plus exactly one of
|
|
7535
7536
|
`redshift.clusterIdentifier` (provisioned cluster) or
|
|
7536
7537
|
`redshift.workgroupName` (Redshift Serverless).
|
|
7537
|
-
- **MSSQL with `mssql.authType=azure-service-principal`**
|
|
7538
|
-
`_iClientId`
|
|
7538
|
+
- **MSSQL / Azure Synapse with `mssql.authType=azure-service-principal`**
|
|
7539
|
+
— requires `_iClientId` referencing an `azureserviceprincipal` iClient
|
|
7540
|
+
(the Microsoft Entra tenant id, client id and client secret or
|
|
7541
|
+
certificate live in the iClient); `user` and `password` are not used.
|
|
7542
|
+
`_iClientId` with `basic` auth is rejected. Both types share the
|
|
7543
|
+
`mssql` sub-object; `azuresynapse` is cloud-only, and the SQL Server
|
|
7544
|
+
connection form offers service-principal auth in Cloud mode only — it
|
|
7545
|
+
saves `basic` for an on-premise connection (`_agentId` set).
|
|
7539
7546
|
- **Oracle** — runs in agent mode only, so requires `_agentId` on the
|
|
7540
7547
|
parent connection object. Uses `serviceName` instead of `database`.
|
|
7541
7548
|
Optionally also takes `serverType` and `instanceName`.
|
|
@@ -7628,8 +7635,10 @@ components:
|
|
|
7628
7635
|
user:
|
|
7629
7636
|
type: string
|
|
7630
7637
|
description: |
|
|
7631
|
-
Database username for authentication.
|
|
7632
|
-
|
|
7638
|
+
Database username for authentication. Required for all types except
|
|
7639
|
+
BigQuery (service account auth), Redshift, and `mssql` / `azuresynapse`
|
|
7640
|
+
with `mssql.authType=azure-service-principal`, where the Entra principal
|
|
7641
|
+
in the iClient signs in and a `user` sent anyway is stored unused.
|
|
7633
7642
|
examples:
|
|
7634
7643
|
- integration_user
|
|
7635
7644
|
password:
|
|
@@ -7756,8 +7765,11 @@ components:
|
|
|
7756
7765
|
- keyPair
|
|
7757
7766
|
mssql:
|
|
7758
7767
|
type: object
|
|
7759
|
-
description:
|
|
7760
|
-
Microsoft SQL Server / Azure Synapse-specific configuration.
|
|
7768
|
+
description: |-
|
|
7769
|
+
Microsoft SQL Server / Azure Synapse-specific configuration. Read for
|
|
7770
|
+
both the `mssql` and the `azuresynapse` types — Azure Synapse
|
|
7771
|
+
Analytics shares SQL Server's authentication model and this
|
|
7772
|
+
sub-object.
|
|
7761
7773
|
properties:
|
|
7762
7774
|
authType:
|
|
7763
7775
|
type: string
|
|
@@ -7765,14 +7777,30 @@ components:
|
|
|
7765
7777
|
- basic
|
|
7766
7778
|
- azure-service-principal
|
|
7767
7779
|
x-enumDescriptions:
|
|
7768
|
-
basic:
|
|
7769
|
-
azure-service-principal:
|
|
7780
|
+
basic: Database user — SQL authentication with `user` and `password`
|
|
7781
|
+
azure-service-principal: Microsoft Entra service principal held in the `azureserviceprincipal` iClient referenced by `_iClientId`; `user` and `password` are not used
|
|
7770
7782
|
description: |-
|
|
7771
|
-
|
|
7772
|
-
|
|
7783
|
+
How a Microsoft SQL Server or Azure Synapse connection
|
|
7784
|
+
authenticates. Defaults to `basic` when omitted (the connection
|
|
7785
|
+
form's "Database user"). With `azure-service-principal` the
|
|
7786
|
+
connection signs in as the Entra application registered in the
|
|
7787
|
+
iClient — a client secret, or on SQL Server a certificate — and
|
|
7788
|
+
`_iClientId` must reference it. The SQL Server connection form
|
|
7789
|
+
offers `azure-service-principal` in Cloud mode only and saves
|
|
7790
|
+
`basic` for an on-premise connection (`_agentId` set).
|
|
7773
7791
|
default: basic
|
|
7774
7792
|
examples:
|
|
7775
7793
|
- basic
|
|
7794
|
+
x-celigo-ai-guidance:
|
|
7795
|
+
- |-
|
|
7796
|
+
With azure-service-principal, omit user and password: the API does not reject them —
|
|
7797
|
+
it stores them unused on the connection (live-verified 201 with both present), while
|
|
7798
|
+
the connection form removes them on save. Set them only for basic.
|
|
7799
|
+
- |-
|
|
7800
|
+
A certificate-method azureserviceprincipal iClient is offered by the form on Microsoft
|
|
7801
|
+
SQL Server connections only; the Azure Synapse form's picker lists client-secret
|
|
7802
|
+
iClients. The API accepts either on either type (live-verified 201), so follow the
|
|
7803
|
+
form: bind a certificate iClient to mssql connections only.
|
|
7776
7804
|
bigquery:
|
|
7777
7805
|
type: object
|
|
7778
7806
|
description: |
|
|
@@ -7953,10 +7981,13 @@ components:
|
|
|
7953
7981
|
x-celigo-refModel: iclients
|
|
7954
7982
|
description: |-
|
|
7955
7983
|
Reference to an iClient holding auth credentials, stored inside the
|
|
7956
|
-
rdbms object. Required when type is `mssql`
|
|
7957
|
-
`azure-service-principal` (
|
|
7958
|
-
|
|
7959
|
-
|
|
7984
|
+
rdbms object. Required when type is `mssql` or `azuresynapse` and
|
|
7985
|
+
`mssql.authType` is `azure-service-principal` (an
|
|
7986
|
+
`azureserviceprincipal` iClient — the Microsoft Entra tenant id,
|
|
7987
|
+
client id and client secret or certificate), and when type is
|
|
7988
|
+
`redshift` and `redshift.authType` is `awsIam` (an `awsIam`-provider
|
|
7989
|
+
iClient holding the role ARN to assume). On `mssql` / `azuresynapse`
|
|
7990
|
+
it is rejected when `mssql.authType` is `basic` or omitted. For
|
|
7960
7991
|
Redshift the iClient must carry `awsIam.roleArn`, and that role's name
|
|
7961
7992
|
must start with `celigo-data-warehouse-adaptor-` — the data-warehouse
|
|
7962
7993
|
service assumes only roles in that family, so a role created for an S3
|
|
@@ -7964,6 +7995,18 @@ components:
|
|
|
7964
7995
|
examples:
|
|
7965
7996
|
- 66a1b2c3d4e5f60718293a4b
|
|
7966
7997
|
x-celigo-ai-guidance:
|
|
7998
|
+
- |-
|
|
7999
|
+
For a mssql or azuresynapse connection with mssql.authType "azure-service-principal",
|
|
8000
|
+
_iClientId is required (otherwise 422 missing_required_field on rdbms._iClientId
|
|
8001
|
+
"Expected field: _iClientId to be present.") and must reference an azureserviceprincipal
|
|
8002
|
+
iClient (otherwise 422 invalid_field on rdbms._iClientId "IClient provider must be
|
|
8003
|
+
azureserviceprincipal for Service Principal authentication."). The same iClient can back
|
|
8004
|
+
Azure Data Lake Storage Gen2, SQL Server and Synapse connections.
|
|
8005
|
+
- |-
|
|
8006
|
+
With mssql.authType "basic" (or omitted) on mssql / azuresynapse, do not set _iClientId:
|
|
8007
|
+
422 invalid_field on rdbms._iClientId "The _iClientId field should not be set when using
|
|
8008
|
+
basic authentication. Remove _iClientId or switch to azure-service-principal
|
|
8009
|
+
authentication."
|
|
7967
8010
|
- |-
|
|
7968
8011
|
For a Redshift connection with redshift.authType "awsIam", the referenced iClient must
|
|
7969
8012
|
have awsIam.roleArn set (otherwise 422 missing_required_field on rdbms._iClientId
|
|
@@ -7983,7 +8026,6 @@ components:
|
|
|
7983
8026
|
- mysql
|
|
7984
8027
|
- postgresql
|
|
7985
8028
|
- mariadb
|
|
7986
|
-
- azuresynapse
|
|
7987
8029
|
required:
|
|
7988
8030
|
- type
|
|
7989
8031
|
then:
|
|
@@ -8027,120 +8069,149 @@ components:
|
|
|
8027
8069
|
if:
|
|
8028
8070
|
properties:
|
|
8029
8071
|
type:
|
|
8030
|
-
const:
|
|
8072
|
+
const: azuresynapse
|
|
8031
8073
|
required:
|
|
8032
8074
|
- type
|
|
8033
8075
|
then:
|
|
8034
|
-
required:
|
|
8035
|
-
- host
|
|
8036
|
-
- database
|
|
8037
|
-
- user
|
|
8038
|
-
properties:
|
|
8039
|
-
snowflake:
|
|
8040
|
-
required:
|
|
8041
|
-
- authType
|
|
8042
|
-
- warehouse
|
|
8043
8076
|
if:
|
|
8044
8077
|
properties:
|
|
8045
|
-
|
|
8078
|
+
mssql:
|
|
8046
8079
|
properties:
|
|
8047
8080
|
authType:
|
|
8048
|
-
const:
|
|
8081
|
+
const: azure-service-principal
|
|
8049
8082
|
required:
|
|
8050
8083
|
- authType
|
|
8051
8084
|
required:
|
|
8052
|
-
-
|
|
8085
|
+
- mssql
|
|
8053
8086
|
then:
|
|
8054
8087
|
required:
|
|
8055
|
-
-
|
|
8088
|
+
- host
|
|
8089
|
+
- database
|
|
8090
|
+
- _iClientId
|
|
8056
8091
|
else:
|
|
8057
8092
|
required:
|
|
8093
|
+
- host
|
|
8094
|
+
- database
|
|
8095
|
+
- user
|
|
8058
8096
|
- password
|
|
8059
8097
|
else:
|
|
8060
8098
|
if:
|
|
8061
8099
|
properties:
|
|
8062
8100
|
type:
|
|
8063
|
-
const:
|
|
8101
|
+
const: snowflake
|
|
8064
8102
|
required:
|
|
8065
8103
|
- type
|
|
8066
8104
|
then:
|
|
8067
8105
|
required:
|
|
8068
8106
|
- host
|
|
8107
|
+
- database
|
|
8069
8108
|
- user
|
|
8070
|
-
|
|
8109
|
+
properties:
|
|
8110
|
+
snowflake:
|
|
8111
|
+
required:
|
|
8112
|
+
- authType
|
|
8113
|
+
- warehouse
|
|
8114
|
+
if:
|
|
8115
|
+
properties:
|
|
8116
|
+
snowflake:
|
|
8117
|
+
properties:
|
|
8118
|
+
authType:
|
|
8119
|
+
const: keyPair
|
|
8120
|
+
required:
|
|
8121
|
+
- authType
|
|
8122
|
+
required:
|
|
8123
|
+
- snowflake
|
|
8124
|
+
then:
|
|
8125
|
+
required:
|
|
8126
|
+
- key
|
|
8127
|
+
else:
|
|
8128
|
+
required:
|
|
8129
|
+
- password
|
|
8071
8130
|
else:
|
|
8072
8131
|
if:
|
|
8073
8132
|
properties:
|
|
8074
8133
|
type:
|
|
8075
|
-
const:
|
|
8134
|
+
const: oracle
|
|
8076
8135
|
required:
|
|
8077
8136
|
- type
|
|
8078
8137
|
then:
|
|
8079
8138
|
required:
|
|
8080
|
-
-
|
|
8081
|
-
|
|
8082
|
-
|
|
8083
|
-
required:
|
|
8084
|
-
- projectId
|
|
8085
|
-
- dataset
|
|
8086
|
-
- clientEmail
|
|
8087
|
-
- privateKey
|
|
8139
|
+
- host
|
|
8140
|
+
- user
|
|
8141
|
+
- password
|
|
8088
8142
|
else:
|
|
8089
8143
|
if:
|
|
8090
8144
|
properties:
|
|
8091
8145
|
type:
|
|
8092
|
-
const:
|
|
8146
|
+
const: bigquery
|
|
8093
8147
|
required:
|
|
8094
8148
|
- type
|
|
8095
8149
|
then:
|
|
8096
8150
|
required:
|
|
8097
|
-
-
|
|
8098
|
-
- user
|
|
8099
|
-
- redshift
|
|
8151
|
+
- bigquery
|
|
8100
8152
|
properties:
|
|
8101
|
-
|
|
8153
|
+
bigquery:
|
|
8102
8154
|
required:
|
|
8103
|
-
-
|
|
8155
|
+
- projectId
|
|
8156
|
+
- dataset
|
|
8157
|
+
- clientEmail
|
|
8158
|
+
- privateKey
|
|
8159
|
+
else:
|
|
8104
8160
|
if:
|
|
8105
|
-
required:
|
|
8106
|
-
- redshift
|
|
8107
8161
|
properties:
|
|
8108
|
-
|
|
8109
|
-
|
|
8110
|
-
|
|
8111
|
-
|
|
8112
|
-
authType:
|
|
8113
|
-
const: awsIam
|
|
8162
|
+
type:
|
|
8163
|
+
const: redshift
|
|
8164
|
+
required:
|
|
8165
|
+
- type
|
|
8114
8166
|
then:
|
|
8115
8167
|
required:
|
|
8116
|
-
-
|
|
8117
|
-
|
|
8118
|
-
redshift
|
|
8119
|
-
oneOf:
|
|
8120
|
-
- required:
|
|
8121
|
-
- clusterIdentifier
|
|
8122
|
-
not:
|
|
8123
|
-
required:
|
|
8124
|
-
- workgroupName
|
|
8125
|
-
- required:
|
|
8126
|
-
- workgroupName
|
|
8127
|
-
not:
|
|
8128
|
-
required:
|
|
8129
|
-
- clusterIdentifier
|
|
8130
|
-
else:
|
|
8168
|
+
- database
|
|
8169
|
+
- user
|
|
8170
|
+
- redshift
|
|
8131
8171
|
properties:
|
|
8132
8172
|
redshift:
|
|
8133
8173
|
required:
|
|
8134
|
-
-
|
|
8135
|
-
|
|
8136
|
-
|
|
8174
|
+
- region
|
|
8175
|
+
if:
|
|
8176
|
+
required:
|
|
8177
|
+
- redshift
|
|
8178
|
+
properties:
|
|
8179
|
+
redshift:
|
|
8137
8180
|
required:
|
|
8138
|
-
-
|
|
8139
|
-
|
|
8140
|
-
|
|
8181
|
+
- authType
|
|
8182
|
+
properties:
|
|
8183
|
+
authType:
|
|
8184
|
+
const: awsIam
|
|
8185
|
+
then:
|
|
8186
|
+
required:
|
|
8187
|
+
- _iClientId
|
|
8188
|
+
properties:
|
|
8189
|
+
redshift:
|
|
8190
|
+
oneOf:
|
|
8191
|
+
- required:
|
|
8192
|
+
- clusterIdentifier
|
|
8193
|
+
not:
|
|
8194
|
+
required:
|
|
8195
|
+
- workgroupName
|
|
8196
|
+
- required:
|
|
8197
|
+
- workgroupName
|
|
8198
|
+
not:
|
|
8199
|
+
required:
|
|
8200
|
+
- clusterIdentifier
|
|
8201
|
+
else:
|
|
8202
|
+
properties:
|
|
8203
|
+
redshift:
|
|
8204
|
+
required:
|
|
8205
|
+
- aws
|
|
8206
|
+
- clusterIdentifier
|
|
8207
|
+
not:
|
|
8141
8208
|
required:
|
|
8142
|
-
-
|
|
8143
|
-
|
|
8209
|
+
- workgroupName
|
|
8210
|
+
properties:
|
|
8211
|
+
aws:
|
|
8212
|
+
required:
|
|
8213
|
+
- accessKeyId
|
|
8214
|
+
- secretAccessKey
|
|
8144
8215
|
MongoDB:
|
|
8145
8216
|
type: object
|
|
8146
8217
|
description: |-
|