@celigo/api-specs 0.2.77 → 0.2.79
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 +9 -5
- package/dist/connection.yml +23 -5
- package/dist/enduser.yml +9 -5
- package/dist/iclient.yml +47 -11
- package/dist/import.yml +24 -0
- package/dist/mcp-server.yml +9 -5
- package/dist/tool.yml +33 -5
- package/package.json +1 -1
- package/schemas.json +2 -2
package/dist/api.yml
CHANGED
|
@@ -7260,11 +7260,15 @@ components:
|
|
|
7260
7260
|
x-celigo-ai-guidance:
|
|
7261
7261
|
- |-
|
|
7262
7262
|
Required when the GCS connection authenticates through an OAuth
|
|
7263
|
-
iClient (provider custom_oauth2)
|
|
7264
|
-
with
|
|
7265
|
-
|
|
7266
|
-
|
|
7267
|
-
|
|
7263
|
+
iClient (provider custom_oauth2). Omitting it fails the save
|
|
7264
|
+
with 422 project_id_missing on http.unencrypted.googleProjectId
|
|
7265
|
+
— "Default project ID is required on OAuth Google Cloud Storage
|
|
7266
|
+
connections (http.unencrypted.googleProjectId)." With a
|
|
7267
|
+
googleserviceaccount iClient the server fills this from the
|
|
7268
|
+
key's project_id. Any other provider fails with 422
|
|
7269
|
+
invalid_field on http._iClientId — "IClient provider must be
|
|
7270
|
+
googleserviceaccount or custom_oauth2 for Google Cloud Storage
|
|
7271
|
+
connections."
|
|
7268
7272
|
unencryptedFields:
|
|
7269
7273
|
type: array
|
|
7270
7274
|
description: |
|
package/dist/connection.yml
CHANGED
|
@@ -701,6 +701,20 @@ paths:
|
|
|
701
701
|
- field: http._iClientId
|
|
702
702
|
code: invalid_field
|
|
703
703
|
message: IClient provider must be azureserviceprincipal for Azure Data Lake Storage Gen2 connections.
|
|
704
|
+
gcsIClientWrongProvider:
|
|
705
|
+
summary: Google Cloud Storage connection referencing an iClient that is neither a service account nor OAuth
|
|
706
|
+
value:
|
|
707
|
+
errors:
|
|
708
|
+
- field: http._iClientId
|
|
709
|
+
code: invalid_field
|
|
710
|
+
message: IClient provider must be googleserviceaccount or custom_oauth2 for Google Cloud Storage connections.
|
|
711
|
+
gcsProjectIdMissing:
|
|
712
|
+
summary: Google Cloud Storage OAuth connection without a project id
|
|
713
|
+
value:
|
|
714
|
+
errors:
|
|
715
|
+
- field: http.unencrypted.googleProjectId
|
|
716
|
+
code: project_id_missing
|
|
717
|
+
message: Default project ID is required on OAuth Google Cloud Storage connections (http.unencrypted.googleProjectId).
|
|
704
718
|
x-celigo-ai-guidance:
|
|
705
719
|
- |-
|
|
706
720
|
Send exactly one adaptor config object, the one named by `type`. Credentials are accepted
|
|
@@ -5853,11 +5867,15 @@ components:
|
|
|
5853
5867
|
x-celigo-ai-guidance:
|
|
5854
5868
|
- |-
|
|
5855
5869
|
Required when the GCS connection authenticates through an OAuth
|
|
5856
|
-
iClient (provider custom_oauth2)
|
|
5857
|
-
with
|
|
5858
|
-
|
|
5859
|
-
|
|
5860
|
-
|
|
5870
|
+
iClient (provider custom_oauth2). Omitting it fails the save
|
|
5871
|
+
with 422 project_id_missing on http.unencrypted.googleProjectId
|
|
5872
|
+
— "Default project ID is required on OAuth Google Cloud Storage
|
|
5873
|
+
connections (http.unencrypted.googleProjectId)." With a
|
|
5874
|
+
googleserviceaccount iClient the server fills this from the
|
|
5875
|
+
key's project_id. Any other provider fails with 422
|
|
5876
|
+
invalid_field on http._iClientId — "IClient provider must be
|
|
5877
|
+
googleserviceaccount or custom_oauth2 for Google Cloud Storage
|
|
5878
|
+
connections."
|
|
5861
5879
|
unencryptedFields:
|
|
5862
5880
|
type: array
|
|
5863
5881
|
description: |
|
package/dist/enduser.yml
CHANGED
|
@@ -4506,11 +4506,15 @@ components:
|
|
|
4506
4506
|
x-celigo-ai-guidance:
|
|
4507
4507
|
- |-
|
|
4508
4508
|
Required when the GCS connection authenticates through an OAuth
|
|
4509
|
-
iClient (provider custom_oauth2)
|
|
4510
|
-
with
|
|
4511
|
-
|
|
4512
|
-
|
|
4513
|
-
|
|
4509
|
+
iClient (provider custom_oauth2). Omitting it fails the save
|
|
4510
|
+
with 422 project_id_missing on http.unencrypted.googleProjectId
|
|
4511
|
+
— "Default project ID is required on OAuth Google Cloud Storage
|
|
4512
|
+
connections (http.unencrypted.googleProjectId)." With a
|
|
4513
|
+
googleserviceaccount iClient the server fills this from the
|
|
4514
|
+
key's project_id. Any other provider fails with 422
|
|
4515
|
+
invalid_field on http._iClientId — "IClient provider must be
|
|
4516
|
+
googleserviceaccount or custom_oauth2 for Google Cloud Storage
|
|
4517
|
+
connections."
|
|
4514
4518
|
unencryptedFields:
|
|
4515
4519
|
type: array
|
|
4516
4520
|
description: |
|
package/dist/iclient.yml
CHANGED
|
@@ -254,6 +254,13 @@ paths:
|
|
|
254
254
|
- field: awsIam.roleArn
|
|
255
255
|
code: invalid_field_value
|
|
256
256
|
message: roleArn must match format arn:aws:iam::{account-id}:role/[path/]{role-name}.
|
|
257
|
+
googleServiceAccountInvalidJsonKey:
|
|
258
|
+
summary: Google service account key is missing or not the required JSON
|
|
259
|
+
value:
|
|
260
|
+
errors:
|
|
261
|
+
- field: googleserviceaccount.serviceAccountJSON
|
|
262
|
+
code: invalid_json_key
|
|
263
|
+
message: The service account JSON key is missing, empty, or not valid JSON with required fields (project_id, client_email, private_key).
|
|
257
264
|
/v1/iclients/{_id}:
|
|
258
265
|
get:
|
|
259
266
|
x-internal: false
|
|
@@ -313,7 +320,8 @@ paths:
|
|
|
313
320
|
description: |-
|
|
314
321
|
Replaces an iClient. All mutable fields must be provided — omitted
|
|
315
322
|
fields are reset to defaults. Secrets returned as `"******"` can be
|
|
316
|
-
sent back as-is to keep the existing value
|
|
323
|
+
sent back as-is to keep the existing value, except a Google service
|
|
324
|
+
account: every update must include the full JSON key.
|
|
317
325
|
operationId: updateIClient
|
|
318
326
|
tags:
|
|
319
327
|
- iClients
|
|
@@ -371,7 +379,22 @@ paths:
|
|
|
371
379
|
'404':
|
|
372
380
|
$ref: '#/components/responses/404-not-found'
|
|
373
381
|
'422':
|
|
374
|
-
|
|
382
|
+
description: |-
|
|
383
|
+
Unprocessable entity. The body was well-formed but a credential
|
|
384
|
+
field failed validation. A Google service account update without
|
|
385
|
+
the full JSON key is rejected here.
|
|
386
|
+
content:
|
|
387
|
+
application/json:
|
|
388
|
+
schema:
|
|
389
|
+
$ref: '#/components/schemas/Error'
|
|
390
|
+
examples:
|
|
391
|
+
googleServiceAccountKeyOmitted:
|
|
392
|
+
summary: Google service account update without the full JSON key
|
|
393
|
+
value:
|
|
394
|
+
errors:
|
|
395
|
+
- field: googleserviceaccount.serviceAccountJSON
|
|
396
|
+
code: invalid_json_key
|
|
397
|
+
message: The service account JSON key is missing, empty, or not valid JSON with required fields (project_id, client_email, private_key).
|
|
375
398
|
patch:
|
|
376
399
|
x-internal: false
|
|
377
400
|
summary: Patch an iClient
|
|
@@ -3986,12 +4009,22 @@ components:
|
|
|
3986
4009
|
type: string
|
|
3987
4010
|
writeOnly: true
|
|
3988
4011
|
description: |-
|
|
3989
|
-
|
|
3990
|
-
|
|
3991
|
-
|
|
3992
|
-
|
|
3993
|
-
|
|
3994
|
-
|
|
4012
|
+
Google service-account key file, sent as a JSON string. The save
|
|
4013
|
+
reads `project_id`, `client_email`, and a `private_key` that
|
|
4014
|
+
includes its PEM armor (`-----BEGIN PRIVATE KEY-----` through
|
|
4015
|
+
`-----END PRIVATE KEY-----`). Missing, empty, or incomplete JSON
|
|
4016
|
+
fails with 422 `invalid_json_key`. Send the full key on every
|
|
4017
|
+
create and every update — omitting it or sending `"******"`
|
|
4018
|
+
fails the same way.
|
|
4019
|
+
x-celigo-ai-guidance:
|
|
4020
|
+
- |-
|
|
4021
|
+
A placeholder body inside the PEM armor is accepted on create.
|
|
4022
|
+
A PUT never keeps the stored key: omitting serviceAccountJSON,
|
|
4023
|
+
sending "******", or omitting the googleserviceaccount block
|
|
4024
|
+
all return 422 invalid_json_key on
|
|
4025
|
+
googleserviceaccount.serviceAccountJSON — "The service account
|
|
4026
|
+
JSON key is missing, empty, or not valid JSON with required
|
|
4027
|
+
fields (project_id, client_email, private_key)."
|
|
3995
4028
|
clientEmail:
|
|
3996
4029
|
type: string
|
|
3997
4030
|
readOnly: true
|
|
@@ -4300,9 +4333,12 @@ components:
|
|
|
4300
4333
|
`salesforce`, `ebay`, `amazonmws`, `azureserviceprincipal`,
|
|
4301
4334
|
`googleserviceaccount`, `awsIam`).
|
|
4302
4335
|
For `custom_oauth2`, credentials go in the `oauth2` sub-object.
|
|
4303
|
-
Secrets (`clientSecret`, `privateKey`,
|
|
4304
|
-
as `"******"`.
|
|
4305
|
-
|
|
4336
|
+
Secrets (`clientSecret`, `privateKey`, and so on) come back masked
|
|
4337
|
+
as `"******"`. Re-send that mask on update to keep the stored
|
|
4338
|
+
secret; omitting it does not. A Google service account is the
|
|
4339
|
+
exception: `serviceAccountJSON` is not returned, and every update
|
|
4340
|
+
must send the full key — the mask or an omission fails with 422
|
|
4341
|
+
`invalid_json_key`.
|
|
4306
4342
|
required:
|
|
4307
4343
|
- provider
|
|
4308
4344
|
allOf:
|
package/dist/import.yml
CHANGED
|
@@ -8400,6 +8400,19 @@ components:
|
|
|
8400
8400
|
- 100
|
|
8401
8401
|
File:
|
|
8402
8402
|
type: object
|
|
8403
|
+
x-celigo-excludeAdaptorTypes:
|
|
8404
|
+
- RDBMSImport
|
|
8405
|
+
- JDBCImport
|
|
8406
|
+
- SalesforceImport
|
|
8407
|
+
- NetSuiteImport
|
|
8408
|
+
- MongodbImport
|
|
8409
|
+
x-celigo-ai-guidance:
|
|
8410
|
+
- |-
|
|
8411
|
+
Never author or patch `file` on an `RDBMSImport`. On a bulk load the API echoes a
|
|
8412
|
+
platform-derived `file` object whose values a save cannot change: the write is accepted,
|
|
8413
|
+
the change is discarded, and a read-back shows the original values. Shape the records
|
|
8414
|
+
before the write (a preMap/postMap hook, the mapping, a transform) or correct the source
|
|
8415
|
+
data instead.
|
|
8403
8416
|
description: |-
|
|
8404
8417
|
**CRITICAL: This object is REQUIRED for all file-based import adaptor types.**
|
|
8405
8418
|
|
|
@@ -8420,6 +8433,17 @@ components:
|
|
|
8420
8433
|
- `HTTPImport` in records mode (`http.type` unset — a REST endpoint receiving records)
|
|
8421
8434
|
- `MongodbImport`
|
|
8422
8435
|
- `RDBMSImport`
|
|
8436
|
+
- `JDBCImport`
|
|
8437
|
+
|
|
8438
|
+
**Read-only on database bulk loads**
|
|
8439
|
+
|
|
8440
|
+
An `RDBMSImport` whose `rdbms.queryType` is `bulk_load` returns a `file` object anyway: the
|
|
8441
|
+
platform's description of the staging file it generates for the load (delimiter, quoting,
|
|
8442
|
+
newline handling, and how the load is batched into files). It is derived on every read,
|
|
8443
|
+
never stored — a save that changes it is accepted and the change discarded (the audit log
|
|
8444
|
+
still records the request), and the import editor has no control for it. Change what
|
|
8445
|
+
reaches the destination with a preMap/postMap hook, the mapping, or a transform, or correct
|
|
8446
|
+
the source data.
|
|
8423
8447
|
|
|
8424
8448
|
**Minimum required fields**
|
|
8425
8449
|
|
package/dist/mcp-server.yml
CHANGED
|
@@ -6316,11 +6316,15 @@ components:
|
|
|
6316
6316
|
x-celigo-ai-guidance:
|
|
6317
6317
|
- |-
|
|
6318
6318
|
Required when the GCS connection authenticates through an OAuth
|
|
6319
|
-
iClient (provider custom_oauth2)
|
|
6320
|
-
with
|
|
6321
|
-
|
|
6322
|
-
|
|
6323
|
-
|
|
6319
|
+
iClient (provider custom_oauth2). Omitting it fails the save
|
|
6320
|
+
with 422 project_id_missing on http.unencrypted.googleProjectId
|
|
6321
|
+
— "Default project ID is required on OAuth Google Cloud Storage
|
|
6322
|
+
connections (http.unencrypted.googleProjectId)." With a
|
|
6323
|
+
googleserviceaccount iClient the server fills this from the
|
|
6324
|
+
key's project_id. Any other provider fails with 422
|
|
6325
|
+
invalid_field on http._iClientId — "IClient provider must be
|
|
6326
|
+
googleserviceaccount or custom_oauth2 for Google Cloud Storage
|
|
6327
|
+
connections."
|
|
6324
6328
|
unencryptedFields:
|
|
6325
6329
|
type: array
|
|
6326
6330
|
description: |
|
package/dist/tool.yml
CHANGED
|
@@ -8959,11 +8959,15 @@ components:
|
|
|
8959
8959
|
x-celigo-ai-guidance:
|
|
8960
8960
|
- |-
|
|
8961
8961
|
Required when the GCS connection authenticates through an OAuth
|
|
8962
|
-
iClient (provider custom_oauth2)
|
|
8963
|
-
with
|
|
8964
|
-
|
|
8965
|
-
|
|
8966
|
-
|
|
8962
|
+
iClient (provider custom_oauth2). Omitting it fails the save
|
|
8963
|
+
with 422 project_id_missing on http.unencrypted.googleProjectId
|
|
8964
|
+
— "Default project ID is required on OAuth Google Cloud Storage
|
|
8965
|
+
connections (http.unencrypted.googleProjectId)." With a
|
|
8966
|
+
googleserviceaccount iClient the server fills this from the
|
|
8967
|
+
key's project_id. Any other provider fails with 422
|
|
8968
|
+
invalid_field on http._iClientId — "IClient provider must be
|
|
8969
|
+
googleserviceaccount or custom_oauth2 for Google Cloud Storage
|
|
8970
|
+
connections."
|
|
8967
8971
|
unencryptedFields:
|
|
8968
8972
|
type: array
|
|
8969
8973
|
description: |
|
|
@@ -18798,6 +18802,19 @@ components:
|
|
|
18798
18802
|
- 100
|
|
18799
18803
|
File:
|
|
18800
18804
|
type: object
|
|
18805
|
+
x-celigo-excludeAdaptorTypes:
|
|
18806
|
+
- RDBMSImport
|
|
18807
|
+
- JDBCImport
|
|
18808
|
+
- SalesforceImport
|
|
18809
|
+
- NetSuiteImport
|
|
18810
|
+
- MongodbImport
|
|
18811
|
+
x-celigo-ai-guidance:
|
|
18812
|
+
- |-
|
|
18813
|
+
Never author or patch `file` on an `RDBMSImport`. On a bulk load the API echoes a
|
|
18814
|
+
platform-derived `file` object whose values a save cannot change: the write is accepted,
|
|
18815
|
+
the change is discarded, and a read-back shows the original values. Shape the records
|
|
18816
|
+
before the write (a preMap/postMap hook, the mapping, a transform) or correct the source
|
|
18817
|
+
data instead.
|
|
18801
18818
|
description: |-
|
|
18802
18819
|
**CRITICAL: This object is REQUIRED for all file-based import adaptor types.**
|
|
18803
18820
|
|
|
@@ -18818,6 +18835,17 @@ components:
|
|
|
18818
18835
|
- `HTTPImport` in records mode (`http.type` unset — a REST endpoint receiving records)
|
|
18819
18836
|
- `MongodbImport`
|
|
18820
18837
|
- `RDBMSImport`
|
|
18838
|
+
- `JDBCImport`
|
|
18839
|
+
|
|
18840
|
+
**Read-only on database bulk loads**
|
|
18841
|
+
|
|
18842
|
+
An `RDBMSImport` whose `rdbms.queryType` is `bulk_load` returns a `file` object anyway: the
|
|
18843
|
+
platform's description of the staging file it generates for the load (delimiter, quoting,
|
|
18844
|
+
newline handling, and how the load is batched into files). It is derived on every read,
|
|
18845
|
+
never stored — a save that changes it is accepted and the change discarded (the audit log
|
|
18846
|
+
still records the request), and the import editor has no control for it. Change what
|
|
18847
|
+
reaches the destination with a preMap/postMap hook, the mapping, or a transform, or correct
|
|
18848
|
+
the source data.
|
|
18821
18849
|
|
|
18822
18850
|
**Minimum required fields**
|
|
18823
18851
|
|
package/package.json
CHANGED