@celigo/api-specs 0.2.192 → 0.2.194
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 +75 -20
- package/dist/connection.yml +76 -21
- package/dist/enduser.yml +75 -20
- package/dist/mcp-server.yml +1130 -40
- package/dist/tool.yml +75 -20
- package/package.json +1 -1
- package/schemas.json +2 -2
package/dist/tool.yml
CHANGED
|
@@ -10000,23 +10000,51 @@ components:
|
|
|
10000
10000
|
googleProjectId:
|
|
10001
10001
|
type: string
|
|
10002
10002
|
description: |-
|
|
10003
|
-
|
|
10004
|
-
|
|
10005
|
-
`storage.googleapis.com`)
|
|
10003
|
+
Default project ID of a Google Cloud Storage connection (assistant
|
|
10004
|
+
`googlecloudstorage`, or a `baseURI` pointing at
|
|
10005
|
+
`storage.googleapis.com`): the Google Cloud project whose buckets the
|
|
10006
|
+
export and import forms list. It does not limit access — the
|
|
10007
|
+
connection reaches any bucket the authorized Google account or
|
|
10008
|
+
service account may use. Set by the caller on the OAuth 2.0 auth type
|
|
10009
|
+
(Celigo's published Google Cloud Storage iClient or an account-owned
|
|
10010
|
+
`custom_oauth2` iClient). On the Google service account auth type the
|
|
10011
|
+
server stores the key's `project_id` on create and on any save that
|
|
10012
|
+
changes or omits `http.unencrypted`; a save that re-sends the stored
|
|
10013
|
+
`http.unencrypted` unchanged keeps the stored value, even though the
|
|
10014
|
+
response body can echo the key's — read the connection back. Trimmed
|
|
10015
|
+
on save; no format is enforced (the connection form warns on a value
|
|
10016
|
+
outside Google's project-id format and still saves it).
|
|
10006
10017
|
examples:
|
|
10007
10018
|
- my-gcs-project
|
|
10008
10019
|
x-celigo-ai-guidance:
|
|
10009
10020
|
- |-
|
|
10010
10021
|
Required when the GCS connection authenticates through an OAuth
|
|
10011
|
-
iClient
|
|
10012
|
-
|
|
10013
|
-
|
|
10014
|
-
|
|
10015
|
-
|
|
10016
|
-
|
|
10017
|
-
|
|
10022
|
+
iClient — Celigo's published Google Cloud Storage iClient (the id
|
|
10023
|
+
the connector pre-configures on `http._iClientId` when
|
|
10024
|
+
`http.auth.type` is `oauth`) or an account-owned iClient with
|
|
10025
|
+
provider custom_oauth2. Omitting it, or sending only whitespace,
|
|
10026
|
+
fails the save with 422 project_id_missing on
|
|
10027
|
+
http.unencrypted.googleProjectId — "Default project ID is
|
|
10028
|
+
required on OAuth Google Cloud Storage connections
|
|
10029
|
+
(http.unencrypted.googleProjectId)." — on create and on every
|
|
10030
|
+
later PUT. With a googleserviceaccount iClient the server stores
|
|
10031
|
+
the key's project_id on create (a value sent on create is
|
|
10032
|
+
replaced by it) and on any later save that changes or omits
|
|
10033
|
+
`http.unencrypted` — the next bullet has the PUT that does not
|
|
10034
|
+
re-fill it. Any other provider fails with 422 invalid_field
|
|
10035
|
+
on http._iClientId — "IClient provider must be
|
|
10018
10036
|
googleserviceaccount or custom_oauth2 for Google Cloud Storage
|
|
10019
10037
|
connections."
|
|
10038
|
+
- |-
|
|
10039
|
+
When a PUT moves the connection from an OAuth iClient to a
|
|
10040
|
+
googleserviceaccount iClient, drop `http.unencrypted` (or change
|
|
10041
|
+
it) in the same PUT: the server's fill from the key is written
|
|
10042
|
+
only when `http.unencrypted` is absent or changed, so a PUT that
|
|
10043
|
+
re-sends the stored object unchanged keeps the OAuth-era project
|
|
10044
|
+
id beside the service account (the 200 body still echoes the
|
|
10045
|
+
key's — only a GET shows what persisted). Moving the other way
|
|
10046
|
+
(service account → OAuth) needs the project id in the PUT, or it
|
|
10047
|
+
is the 422 above.
|
|
10020
10048
|
unencryptedFields:
|
|
10021
10049
|
type: array
|
|
10022
10050
|
description: |
|
|
@@ -10061,13 +10089,20 @@ components:
|
|
|
10061
10089
|
description: |-
|
|
10062
10090
|
iClient that holds the credentials this connection signs with: the OAuth 2.0 client for
|
|
10063
10091
|
`auth.type` `oauth` (including the `azureserviceprincipal` service principal an Azure
|
|
10064
|
-
Data Lake Storage Gen2 connection authenticates with and
|
|
10065
|
-
|
|
10092
|
+
Data Lake Storage Gen2 connection authenticates with and, on a Google Cloud Storage
|
|
10093
|
+
connection, either the `googleserviceaccount` key of its Google service account auth
|
|
10094
|
+
type or — its OAuth 2.0 auth type — Celigo's published Google Cloud Storage iClient,
|
|
10095
|
+
which the connector pre-configures, or an account-owned `custom_oauth2` iClient), or
|
|
10096
|
+
the `awsIam` role for `auth.type` `awsiam`.
|
|
10066
10097
|
Must belong to the same account as the connection — or be the iClient Celigo publishes
|
|
10067
10098
|
with a pre-built OAuth HTTP connector (pre-configured by the connector; from the
|
|
10068
|
-
connecting account `GET /v1/iclients/{_id}` on it is 404 resource_not_found
|
|
10069
|
-
`GET /v1/iclients` does not list it, yet the
|
|
10070
|
-
|
|
10099
|
+
connecting account `GET /v1/iclients/{_id}` on it is 404 — resource_not_found or
|
|
10100
|
+
invalid_ref "IClient not found." — and `GET /v1/iclients` does not list it, yet the
|
|
10101
|
+
connection saves with it). Omit for every other auth type. A Google Cloud Storage
|
|
10102
|
+
connection stores `auth.type` `oauth` under both of its auth types; the referenced
|
|
10103
|
+
iClient's provider tells them apart, and switching is a PUT that changes `_iClientId`
|
|
10104
|
+
(see `unencrypted.googleProjectId` for what travels with it). On a Shopify connection
|
|
10105
|
+
`settings.appType` says which of the two it
|
|
10071
10106
|
is: `public` rides Celigo's published Shopify app (installed from the Shopify App
|
|
10072
10107
|
Store), `custom` rides the account's own iClient — the Shopify app the customer created
|
|
10073
10108
|
in the Shopify dev dashboard — with `auth.oauth.scope` chosen on the connection. A
|
|
@@ -10082,7 +10117,7 @@ components:
|
|
|
10082
10117
|
published app and carry no `settings.appType`.
|
|
10083
10118
|
examples:
|
|
10084
10119
|
- 6203a7e4f321d800129a1b8e
|
|
10085
|
-
x-celigo-ui-override: 'Required by the connection form for oauth (subForms/httpOAuth.js: required true, iClient filter provider custom_oauth2, or googleserviceaccount / azureserviceprincipal for the GCS and ADLS Gen2 variants) and for awsIam (subForms/httpAwsIam.js: required true, filter provider awsIam). For oauth the API creates the connection without it and the authorization is completed afterward; for awsiam the API also rejects its absence (see the if/then rule on this schema).'
|
|
10120
|
+
x-celigo-ui-override: 'Required by the connection form for oauth (subForms/httpOAuth.js: required true, iClient filter provider custom_oauth2 — on a Google Cloud Storage connection''s OAuth 2.0 auth type too, where Simple view pre-selects Celigo''s published iClient and hides the picker — or googleserviceaccount / azureserviceprincipal for the GCS Google service account and ADLS Gen2 variants) and for awsIam (subForms/httpAwsIam.js: required true, filter provider awsIam). For oauth the API creates the connection without it and the authorization is completed afterward; for awsiam the API also rejects its absence (see the if/then rule on this schema).'
|
|
10086
10121
|
x-celigo-ai-guidance:
|
|
10087
10122
|
- |-
|
|
10088
10123
|
For auth.type "awsiam" the referenced iClient must have provider "awsIam" (any other
|
|
@@ -10101,10 +10136,30 @@ components:
|
|
|
10101
10136
|
The iClient must belong to the same account as the connection — an iClient id from
|
|
10102
10137
|
another account fails with 422 invalid_ref "The referenced IClient must belong to the
|
|
10103
10138
|
same user." The one exception is the iClient a pre-built OAuth HTTP connector
|
|
10104
|
-
pre-configures (Celigo's published app — the Shopify Public App's
|
|
10105
|
-
connection saves with that id from the
|
|
10106
|
-
`GET /v1/iclients/{_id}` on it is 404 there, so do not
|
|
10107
|
-
connection
|
|
10139
|
+
pre-configures (Celigo's published app — the Shopify Public App's and the Google Cloud
|
|
10140
|
+
Storage OAuth 2.0 iClient, for two): the connection saves with that id from the
|
|
10141
|
+
connecting account even though `GET /v1/iclients/{_id}` on it is 404 there, so do not
|
|
10142
|
+
refuse a `public` Shopify connection or an OAuth 2.0 Google Cloud Storage connection on
|
|
10143
|
+
this rule. Read the id from the connector's metadata
|
|
10144
|
+
(`GET /v1/httpconnectors/{_id}?returnEverything=true`,
|
|
10145
|
+
`supportedBy.connection.preConfiguredFields` entry for `http._iClientId`), never from
|
|
10146
|
+
a hard-coded value.
|
|
10147
|
+
- |-
|
|
10148
|
+
A Google Cloud Storage connection (assistant "googlecloudstorage", or any http.baseURI
|
|
10149
|
+
containing "storage.googleapis.com") references either a googleserviceaccount iClient
|
|
10150
|
+
of the same account (its Google service account auth type — no authorization step; the
|
|
10151
|
+
server stores the key's project_id in `unencrypted.googleProjectId` on create and
|
|
10152
|
+
whenever `http.unencrypted` changes or is omitted — see that field) or an OAuth iClient
|
|
10153
|
+
with `unencrypted.googleProjectId` set (its OAuth 2.0 auth type — Celigo's published
|
|
10154
|
+
iClient, or an account-owned custom_oauth2 one — authorized afterwards in a browser;
|
|
10155
|
+
until then `POST /v1/connections/{_id}/ping` answers `missing_token`). The server
|
|
10156
|
+
checks the provider only — a custom_oauth2 iClient registered for a different HTTP
|
|
10157
|
+
connector (`_httpConnectorId`) also saves on a GCS connection — so bind an iClient
|
|
10158
|
+
with no connector or the Google Cloud Storage connector's. The connection document
|
|
10159
|
+
keeps `auth.oauth.scope` as sent (a GCS connection saved without it stores none), so
|
|
10160
|
+
send the Cloud Storage scopes on the OAuth 2.0 auth type
|
|
10161
|
+
(https://www.googleapis.com/auth/devstorage.read_write, …read_only or
|
|
10162
|
+
…full_control); a service account connection carries none.
|
|
10108
10163
|
- |-
|
|
10109
10164
|
On a Shopify connection keep `settings.appType` and `_iClientId` in step the way the
|
|
10110
10165
|
form does — `public` with the connector's published iClient, `custom` with an
|
package/package.json
CHANGED