@celigo/api-specs 0.2.103 → 0.2.105

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.
Files changed (13) hide show
  1. package/dist/alert.yml +1226 -0
  2. package/dist/api.yml +152 -81
  3. package/dist/audit.yml +16 -0
  4. package/dist/connection.yml +152 -81
  5. package/dist/enduser.yml +152 -81
  6. package/dist/filestorage.yml +28 -5
  7. package/dist/flow.yml +277 -0
  8. package/dist/iclient.yml +42 -13
  9. package/dist/lookupcache.yml +2 -2
  10. package/dist/mcp-server.yml +152 -81
  11. package/dist/tool.yml +152 -81
  12. package/package.json +1 -1
  13. package/schemas.json +2 -2
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` with
7520
- `azure-service-principal` auth. When SSL cert material IS provided
7521
- without a password, both `ssl.key` and `ssl.cert` become required.
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`** — requires
7538
- `_iClientId` (service principal credentials live in the iClient).
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
- Required for all types except BigQuery (which uses service account auth).
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: Standard SQL Server authentication with username and password.
7769
- azure-service-principal: Azure Active Directory service principal authentication via iClient.
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
- Authentication type for MS SQL Server. Defaults to basic (username/password).
7772
- Use azure-service-principal for Azure AD service principal auth via an iClient.
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` and `mssql.authType` is
7957
- `azure-service-principal` (Azure service-principal credentials), and
7958
- when type is `redshift` and `redshift.authType` is `awsIam` (an
7959
- `awsIam`-provider iClient holding the role ARN to assume). For
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: snowflake
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
- snowflake:
8078
+ mssql:
8046
8079
  properties:
8047
8080
  authType:
8048
- const: keyPair
8081
+ const: azure-service-principal
8049
8082
  required:
8050
8083
  - authType
8051
8084
  required:
8052
- - snowflake
8085
+ - mssql
8053
8086
  then:
8054
8087
  required:
8055
- - key
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: oracle
8101
+ const: snowflake
8064
8102
  required:
8065
8103
  - type
8066
8104
  then:
8067
8105
  required:
8068
8106
  - host
8107
+ - database
8069
8108
  - user
8070
- - password
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: bigquery
8134
+ const: oracle
8076
8135
  required:
8077
8136
  - type
8078
8137
  then:
8079
8138
  required:
8080
- - bigquery
8081
- properties:
8082
- bigquery:
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: redshift
8146
+ const: bigquery
8093
8147
  required:
8094
8148
  - type
8095
8149
  then:
8096
8150
  required:
8097
- - database
8098
- - user
8099
- - redshift
8151
+ - bigquery
8100
8152
  properties:
8101
- redshift:
8153
+ bigquery:
8102
8154
  required:
8103
- - region
8155
+ - projectId
8156
+ - dataset
8157
+ - clientEmail
8158
+ - privateKey
8159
+ else:
8104
8160
  if:
8105
- required:
8106
- - redshift
8107
8161
  properties:
8108
- redshift:
8109
- required:
8110
- - authType
8111
- properties:
8112
- authType:
8113
- const: awsIam
8162
+ type:
8163
+ const: redshift
8164
+ required:
8165
+ - type
8114
8166
  then:
8115
8167
  required:
8116
- - _iClientId
8117
- properties:
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
- - aws
8135
- - clusterIdentifier
8136
- not:
8174
+ - region
8175
+ if:
8176
+ required:
8177
+ - redshift
8178
+ properties:
8179
+ redshift:
8137
8180
  required:
8138
- - workgroupName
8139
- properties:
8140
- aws:
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
- - accessKeyId
8143
- - secretAccessKey
8209
+ - workgroupName
8210
+ properties:
8211
+ aws:
8212
+ required:
8213
+ - accessKeyId
8214
+ - secretAccessKey
8144
8215
  MongoDB:
8145
8216
  type: object
8146
8217
  description: |-
package/dist/audit.yml CHANGED
@@ -79,6 +79,7 @@ paths:
79
79
  enum:
80
80
  - accesstoken
81
81
  - agent
82
+ - alert
82
83
  - api
83
84
  - ashare
84
85
  - asynchelper
@@ -116,6 +117,7 @@ paths:
116
117
  x-enumDescriptions:
117
118
  accesstoken: API access token resource.
118
119
  agent: On-premise agent resource.
120
+ alert: Proactive alert resource.
119
121
  api: Custom API endpoint resource.
120
122
  ashare: Workspace user access record (account share) resource.
121
123
  asynchelper: Async helper resource used for long-running operations.
@@ -513,6 +515,7 @@ paths:
513
515
  enum:
514
516
  - accesstoken
515
517
  - agent
518
+ - alert
516
519
  - api
517
520
  - ashare
518
521
  - asynchelper
@@ -547,6 +550,7 @@ paths:
547
550
  x-enumDescriptions:
548
551
  accesstoken: API access token resource.
549
552
  agent: On-premise agent resource.
553
+ alert: Proactive alert resource.
550
554
  api: Custom API endpoint resource.
551
555
  ashare: Workspace user access record (account share) resource.
552
556
  asynchelper: Async helper resource used for long-running operations.
@@ -787,6 +791,7 @@ paths:
787
791
  enum:
788
792
  - accesstokens
789
793
  - agents
794
+ - alerts
790
795
  - apis
791
796
  - asynchelpers
792
797
  - connections
@@ -816,6 +821,7 @@ paths:
816
821
  x-enumDescriptions:
817
822
  accesstokens: API access token resources.
818
823
  agents: On-premise agent resources.
824
+ alerts: Proactive alert resources.
819
825
  apis: Custom API endpoint resources.
820
826
  asynchelpers: Async helper resources.
821
827
  connections: Connection resources.
@@ -1023,6 +1029,7 @@ paths:
1023
1029
  enum:
1024
1030
  - accesstokens
1025
1031
  - agents
1032
+ - alerts
1026
1033
  - apis
1027
1034
  - asynchelpers
1028
1035
  - connections
@@ -1052,6 +1059,7 @@ paths:
1052
1059
  x-enumDescriptions:
1053
1060
  accesstokens: API access token resources.
1054
1061
  agents: On-premise agent resources.
1062
+ alerts: Proactive alert resources.
1055
1063
  apis: Custom API endpoint resources.
1056
1064
  asynchelpers: Async helper resources.
1057
1065
  connections: Connection resources.
@@ -1247,6 +1255,7 @@ paths:
1247
1255
  enum:
1248
1256
  - accesstokens
1249
1257
  - agents
1258
+ - alerts
1250
1259
  - apis
1251
1260
  - asynchelpers
1252
1261
  - connections
@@ -1274,6 +1283,7 @@ paths:
1274
1283
  x-enumDescriptions:
1275
1284
  accesstokens: API access token resources.
1276
1285
  agents: On-premise agent resources.
1286
+ alerts: Proactive alert resources.
1277
1287
  apis: Custom API endpoint resources.
1278
1288
  asynchelpers: Async helper resources.
1279
1289
  connections: Connection resources.
@@ -1437,6 +1447,7 @@ components:
1437
1447
  enum:
1438
1448
  - accesstoken
1439
1449
  - agent
1450
+ - alert
1440
1451
  - api
1441
1452
  - ashare
1442
1453
  - asynchelper
@@ -1473,6 +1484,7 @@ components:
1473
1484
  x-enumDescriptions:
1474
1485
  accesstoken: API access token resource.
1475
1486
  agent: On-premise agent resource.
1487
+ alert: Proactive alert resource.
1476
1488
  api: Custom API endpoint resource.
1477
1489
  ashare: Workspace user access record (account share) resource.
1478
1490
  asynchelper: Async helper resource used for long-running operations.
@@ -1644,6 +1656,7 @@ components:
1644
1656
  enum:
1645
1657
  - accesstoken
1646
1658
  - agent
1659
+ - alert
1647
1660
  - api
1648
1661
  - ashare
1649
1662
  - asynchelper
@@ -1679,6 +1692,7 @@ components:
1679
1692
  x-enumDescriptions:
1680
1693
  accesstoken: API access token resource.
1681
1694
  agent: On-premise agent resource.
1695
+ alert: Proactive alert resource.
1682
1696
  api: Custom API endpoint resource.
1683
1697
  ashare: Workspace user access record (account share) resource.
1684
1698
  asynchelper: Async helper resource used for long-running operations.
@@ -1865,6 +1879,7 @@ components:
1865
1879
  enum:
1866
1880
  - accesstoken
1867
1881
  - agent
1882
+ - alert
1868
1883
  - api
1869
1884
  - ashare
1870
1885
  - asynchelper
@@ -1900,6 +1915,7 @@ components:
1900
1915
  x-enumDescriptions:
1901
1916
  accesstoken: API access token resource.
1902
1917
  agent: On-premise agent resource.
1918
+ alert: Proactive alert resource.
1903
1919
  api: Custom API endpoint resource.
1904
1920
  ashare: Workspace user access record (account share) resource.
1905
1921
  asynchelper: Async helper resource used for long-running operations.