@celigo/api-specs 0.2.185 → 0.2.187
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 +31 -2
- package/dist/connection.yml +31 -2
- package/dist/enduser.yml +31 -2
- package/dist/iclient.yml +8 -0
- package/dist/mcp-server.yml +31 -2
- package/dist/tool.yml +31 -2
- package/package.json +1 -1
- package/schemas.json +3669 -3365
package/dist/api.yml
CHANGED
|
@@ -8017,7 +8017,23 @@ components:
|
|
|
8017
8017
|
`auth.type` `oauth` (including the `azureserviceprincipal` service principal an Azure
|
|
8018
8018
|
Data Lake Storage Gen2 connection authenticates with and the `googleserviceaccount` key
|
|
8019
8019
|
a Google Cloud Storage connection uses), or the `awsIam` role for `auth.type` `awsiam`.
|
|
8020
|
-
Must belong to the same account as the connection
|
|
8020
|
+
Must belong to the same account as the connection — or be the iClient Celigo publishes
|
|
8021
|
+
with a pre-built OAuth HTTP connector (pre-configured by the connector; from the
|
|
8022
|
+
connecting account `GET /v1/iclients/{_id}` on it is 404 resource_not_found and
|
|
8023
|
+
`GET /v1/iclients` does not list it, yet the connection saves with it). Omit for every
|
|
8024
|
+
other auth type. On a Shopify connection `settings.appType` says which of the two it
|
|
8025
|
+
is: `public` rides Celigo's published Shopify app (installed from the Shopify App
|
|
8026
|
+
Store), `custom` rides the account's own iClient — the Shopify app the customer created
|
|
8027
|
+
in the Shopify dev dashboard — with `auth.oauth.scope` chosen on the connection. A
|
|
8028
|
+
connection with no `settings.appType` (saved before the App type existed) rides the
|
|
8029
|
+
published app when its `_iClientId` is the connector's published iClient — the form
|
|
8030
|
+
opens it with no App type selected and it keeps working — and an account-owned iClient
|
|
8031
|
+
otherwise. A saved Public App connection, with or without a stored `settings.appType`,
|
|
8032
|
+
moves to the customer's app by the same re-save: `settings.appType` `custom`, its own
|
|
8033
|
+
`_iClientId` and scopes, then authorizing; the connection form does not offer the
|
|
8034
|
+
reverse, because the Public App flow is authorized from the Shopify App Store and
|
|
8035
|
+
creates a new connection. Integration App connections (`_connectorId`) stay on Celigo's
|
|
8036
|
+
published app and carry no `settings.appType`.
|
|
8021
8037
|
examples:
|
|
8022
8038
|
- 6203a7e4f321d800129a1b8e
|
|
8023
8039
|
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).'
|
|
@@ -8038,7 +8054,20 @@ components:
|
|
|
8038
8054
|
- |-
|
|
8039
8055
|
The iClient must belong to the same account as the connection — an iClient id from
|
|
8040
8056
|
another account fails with 422 invalid_ref "The referenced IClient must belong to the
|
|
8041
|
-
same user."
|
|
8057
|
+
same user." The one exception is the iClient a pre-built OAuth HTTP connector
|
|
8058
|
+
pre-configures (Celigo's published app — the Shopify Public App's, for one): the
|
|
8059
|
+
connection saves with that id from the connecting account even though
|
|
8060
|
+
`GET /v1/iclients/{_id}` on it is 404 there, so do not refuse a `public` Shopify
|
|
8061
|
+
connection on this rule.
|
|
8062
|
+
- |-
|
|
8063
|
+
On a Shopify connection keep `settings.appType` and `_iClientId` in step the way the
|
|
8064
|
+
form does — `public` with the connector's published iClient, `custom` with an
|
|
8065
|
+
account-owned iClient: the API saves either value of `settings.appType` beside either
|
|
8066
|
+
iClient (and any other string under `settings.appType`) — nothing server-side checks
|
|
8067
|
+
the pair, so the form's rule is the only guard. On an update never drop `_iClientId` from
|
|
8068
|
+
an `auth.type` `oauth` connection: 422 invalid_field_update "Removing _iClientId is
|
|
8069
|
+
not allowed for oauth connections due to security reasons." — switch it to another
|
|
8070
|
+
iClient instead.
|
|
8042
8071
|
_httpConnectorId:
|
|
8043
8072
|
type: string
|
|
8044
8073
|
format: objectId
|
package/dist/connection.yml
CHANGED
|
@@ -6636,7 +6636,23 @@ components:
|
|
|
6636
6636
|
`auth.type` `oauth` (including the `azureserviceprincipal` service principal an Azure
|
|
6637
6637
|
Data Lake Storage Gen2 connection authenticates with and the `googleserviceaccount` key
|
|
6638
6638
|
a Google Cloud Storage connection uses), or the `awsIam` role for `auth.type` `awsiam`.
|
|
6639
|
-
Must belong to the same account as the connection
|
|
6639
|
+
Must belong to the same account as the connection — or be the iClient Celigo publishes
|
|
6640
|
+
with a pre-built OAuth HTTP connector (pre-configured by the connector; from the
|
|
6641
|
+
connecting account `GET /v1/iclients/{_id}` on it is 404 resource_not_found and
|
|
6642
|
+
`GET /v1/iclients` does not list it, yet the connection saves with it). Omit for every
|
|
6643
|
+
other auth type. On a Shopify connection `settings.appType` says which of the two it
|
|
6644
|
+
is: `public` rides Celigo's published Shopify app (installed from the Shopify App
|
|
6645
|
+
Store), `custom` rides the account's own iClient — the Shopify app the customer created
|
|
6646
|
+
in the Shopify dev dashboard — with `auth.oauth.scope` chosen on the connection. A
|
|
6647
|
+
connection with no `settings.appType` (saved before the App type existed) rides the
|
|
6648
|
+
published app when its `_iClientId` is the connector's published iClient — the form
|
|
6649
|
+
opens it with no App type selected and it keeps working — and an account-owned iClient
|
|
6650
|
+
otherwise. A saved Public App connection, with or without a stored `settings.appType`,
|
|
6651
|
+
moves to the customer's app by the same re-save: `settings.appType` `custom`, its own
|
|
6652
|
+
`_iClientId` and scopes, then authorizing; the connection form does not offer the
|
|
6653
|
+
reverse, because the Public App flow is authorized from the Shopify App Store and
|
|
6654
|
+
creates a new connection. Integration App connections (`_connectorId`) stay on Celigo's
|
|
6655
|
+
published app and carry no `settings.appType`.
|
|
6640
6656
|
examples:
|
|
6641
6657
|
- 6203a7e4f321d800129a1b8e
|
|
6642
6658
|
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).'
|
|
@@ -6657,7 +6673,20 @@ components:
|
|
|
6657
6673
|
- |-
|
|
6658
6674
|
The iClient must belong to the same account as the connection — an iClient id from
|
|
6659
6675
|
another account fails with 422 invalid_ref "The referenced IClient must belong to the
|
|
6660
|
-
same user."
|
|
6676
|
+
same user." The one exception is the iClient a pre-built OAuth HTTP connector
|
|
6677
|
+
pre-configures (Celigo's published app — the Shopify Public App's, for one): the
|
|
6678
|
+
connection saves with that id from the connecting account even though
|
|
6679
|
+
`GET /v1/iclients/{_id}` on it is 404 there, so do not refuse a `public` Shopify
|
|
6680
|
+
connection on this rule.
|
|
6681
|
+
- |-
|
|
6682
|
+
On a Shopify connection keep `settings.appType` and `_iClientId` in step the way the
|
|
6683
|
+
form does — `public` with the connector's published iClient, `custom` with an
|
|
6684
|
+
account-owned iClient: the API saves either value of `settings.appType` beside either
|
|
6685
|
+
iClient (and any other string under `settings.appType`) — nothing server-side checks
|
|
6686
|
+
the pair, so the form's rule is the only guard. On an update never drop `_iClientId` from
|
|
6687
|
+
an `auth.type` `oauth` connection: 422 invalid_field_update "Removing _iClientId is
|
|
6688
|
+
not allowed for oauth connections due to security reasons." — switch it to another
|
|
6689
|
+
iClient instead.
|
|
6661
6690
|
_httpConnectorId:
|
|
6662
6691
|
type: string
|
|
6663
6692
|
format: objectId
|
package/dist/enduser.yml
CHANGED
|
@@ -4687,7 +4687,23 @@ components:
|
|
|
4687
4687
|
`auth.type` `oauth` (including the `azureserviceprincipal` service principal an Azure
|
|
4688
4688
|
Data Lake Storage Gen2 connection authenticates with and the `googleserviceaccount` key
|
|
4689
4689
|
a Google Cloud Storage connection uses), or the `awsIam` role for `auth.type` `awsiam`.
|
|
4690
|
-
Must belong to the same account as the connection
|
|
4690
|
+
Must belong to the same account as the connection — or be the iClient Celigo publishes
|
|
4691
|
+
with a pre-built OAuth HTTP connector (pre-configured by the connector; from the
|
|
4692
|
+
connecting account `GET /v1/iclients/{_id}` on it is 404 resource_not_found and
|
|
4693
|
+
`GET /v1/iclients` does not list it, yet the connection saves with it). Omit for every
|
|
4694
|
+
other auth type. On a Shopify connection `settings.appType` says which of the two it
|
|
4695
|
+
is: `public` rides Celigo's published Shopify app (installed from the Shopify App
|
|
4696
|
+
Store), `custom` rides the account's own iClient — the Shopify app the customer created
|
|
4697
|
+
in the Shopify dev dashboard — with `auth.oauth.scope` chosen on the connection. A
|
|
4698
|
+
connection with no `settings.appType` (saved before the App type existed) rides the
|
|
4699
|
+
published app when its `_iClientId` is the connector's published iClient — the form
|
|
4700
|
+
opens it with no App type selected and it keeps working — and an account-owned iClient
|
|
4701
|
+
otherwise. A saved Public App connection, with or without a stored `settings.appType`,
|
|
4702
|
+
moves to the customer's app by the same re-save: `settings.appType` `custom`, its own
|
|
4703
|
+
`_iClientId` and scopes, then authorizing; the connection form does not offer the
|
|
4704
|
+
reverse, because the Public App flow is authorized from the Shopify App Store and
|
|
4705
|
+
creates a new connection. Integration App connections (`_connectorId`) stay on Celigo's
|
|
4706
|
+
published app and carry no `settings.appType`.
|
|
4691
4707
|
examples:
|
|
4692
4708
|
- 6203a7e4f321d800129a1b8e
|
|
4693
4709
|
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).'
|
|
@@ -4708,7 +4724,20 @@ components:
|
|
|
4708
4724
|
- |-
|
|
4709
4725
|
The iClient must belong to the same account as the connection — an iClient id from
|
|
4710
4726
|
another account fails with 422 invalid_ref "The referenced IClient must belong to the
|
|
4711
|
-
same user."
|
|
4727
|
+
same user." The one exception is the iClient a pre-built OAuth HTTP connector
|
|
4728
|
+
pre-configures (Celigo's published app — the Shopify Public App's, for one): the
|
|
4729
|
+
connection saves with that id from the connecting account even though
|
|
4730
|
+
`GET /v1/iclients/{_id}` on it is 404 there, so do not refuse a `public` Shopify
|
|
4731
|
+
connection on this rule.
|
|
4732
|
+
- |-
|
|
4733
|
+
On a Shopify connection keep `settings.appType` and `_iClientId` in step the way the
|
|
4734
|
+
form does — `public` with the connector's published iClient, `custom` with an
|
|
4735
|
+
account-owned iClient: the API saves either value of `settings.appType` beside either
|
|
4736
|
+
iClient (and any other string under `settings.appType`) — nothing server-side checks
|
|
4737
|
+
the pair, so the form's rule is the only guard. On an update never drop `_iClientId` from
|
|
4738
|
+
an `auth.type` `oauth` connection: 422 invalid_field_update "Removing _iClientId is
|
|
4739
|
+
not allowed for oauth connections due to security reasons." — switch it to another
|
|
4740
|
+
iClient instead.
|
|
4712
4741
|
_httpConnectorId:
|
|
4713
4742
|
type: string
|
|
4714
4743
|
format: objectId
|
package/dist/iclient.yml
CHANGED
|
@@ -595,6 +595,14 @@ components:
|
|
|
595
595
|
type: string
|
|
596
596
|
description: Authentication provider that determines which credential fields apply.
|
|
597
597
|
x-celigo-ai-guidance:
|
|
598
|
+
- |-
|
|
599
|
+
An OAuth app the customer registers for a pre-built HTTP connector — a Shopify Custom
|
|
600
|
+
App created in the Shopify dev dashboard, for example — is a `custom_oauth2` iClient
|
|
601
|
+
with `_httpConnectorId` (and `_httpConnectorApiId`) pointing at that connector: the
|
|
602
|
+
shape the connection form's iClient editor saves, and the one its OAuth iClient picker
|
|
603
|
+
lists (subForms/httpOAuth.js filters on provider custom_oauth2). The API also accepts a
|
|
604
|
+
connector-named provider such as `shopify` on an account-created iClient, but the form
|
|
605
|
+
never saves one, so prefer `custom_oauth2`.
|
|
598
606
|
- |-
|
|
599
607
|
## IMPORTANT NOTES:
|
|
600
608
|
- This is not a human/vendor label — it is the provider key that selects an authentication method.
|
package/dist/mcp-server.yml
CHANGED
|
@@ -6523,7 +6523,23 @@ components:
|
|
|
6523
6523
|
`auth.type` `oauth` (including the `azureserviceprincipal` service principal an Azure
|
|
6524
6524
|
Data Lake Storage Gen2 connection authenticates with and the `googleserviceaccount` key
|
|
6525
6525
|
a Google Cloud Storage connection uses), or the `awsIam` role for `auth.type` `awsiam`.
|
|
6526
|
-
Must belong to the same account as the connection
|
|
6526
|
+
Must belong to the same account as the connection — or be the iClient Celigo publishes
|
|
6527
|
+
with a pre-built OAuth HTTP connector (pre-configured by the connector; from the
|
|
6528
|
+
connecting account `GET /v1/iclients/{_id}` on it is 404 resource_not_found and
|
|
6529
|
+
`GET /v1/iclients` does not list it, yet the connection saves with it). Omit for every
|
|
6530
|
+
other auth type. On a Shopify connection `settings.appType` says which of the two it
|
|
6531
|
+
is: `public` rides Celigo's published Shopify app (installed from the Shopify App
|
|
6532
|
+
Store), `custom` rides the account's own iClient — the Shopify app the customer created
|
|
6533
|
+
in the Shopify dev dashboard — with `auth.oauth.scope` chosen on the connection. A
|
|
6534
|
+
connection with no `settings.appType` (saved before the App type existed) rides the
|
|
6535
|
+
published app when its `_iClientId` is the connector's published iClient — the form
|
|
6536
|
+
opens it with no App type selected and it keeps working — and an account-owned iClient
|
|
6537
|
+
otherwise. A saved Public App connection, with or without a stored `settings.appType`,
|
|
6538
|
+
moves to the customer's app by the same re-save: `settings.appType` `custom`, its own
|
|
6539
|
+
`_iClientId` and scopes, then authorizing; the connection form does not offer the
|
|
6540
|
+
reverse, because the Public App flow is authorized from the Shopify App Store and
|
|
6541
|
+
creates a new connection. Integration App connections (`_connectorId`) stay on Celigo's
|
|
6542
|
+
published app and carry no `settings.appType`.
|
|
6527
6543
|
examples:
|
|
6528
6544
|
- 6203a7e4f321d800129a1b8e
|
|
6529
6545
|
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).'
|
|
@@ -6544,7 +6560,20 @@ components:
|
|
|
6544
6560
|
- |-
|
|
6545
6561
|
The iClient must belong to the same account as the connection — an iClient id from
|
|
6546
6562
|
another account fails with 422 invalid_ref "The referenced IClient must belong to the
|
|
6547
|
-
same user."
|
|
6563
|
+
same user." The one exception is the iClient a pre-built OAuth HTTP connector
|
|
6564
|
+
pre-configures (Celigo's published app — the Shopify Public App's, for one): the
|
|
6565
|
+
connection saves with that id from the connecting account even though
|
|
6566
|
+
`GET /v1/iclients/{_id}` on it is 404 there, so do not refuse a `public` Shopify
|
|
6567
|
+
connection on this rule.
|
|
6568
|
+
- |-
|
|
6569
|
+
On a Shopify connection keep `settings.appType` and `_iClientId` in step the way the
|
|
6570
|
+
form does — `public` with the connector's published iClient, `custom` with an
|
|
6571
|
+
account-owned iClient: the API saves either value of `settings.appType` beside either
|
|
6572
|
+
iClient (and any other string under `settings.appType`) — nothing server-side checks
|
|
6573
|
+
the pair, so the form's rule is the only guard. On an update never drop `_iClientId` from
|
|
6574
|
+
an `auth.type` `oauth` connection: 422 invalid_field_update "Removing _iClientId is
|
|
6575
|
+
not allowed for oauth connections due to security reasons." — switch it to another
|
|
6576
|
+
iClient instead.
|
|
6548
6577
|
_httpConnectorId:
|
|
6549
6578
|
type: string
|
|
6550
6579
|
format: objectId
|
package/dist/tool.yml
CHANGED
|
@@ -10057,7 +10057,23 @@ components:
|
|
|
10057
10057
|
`auth.type` `oauth` (including the `azureserviceprincipal` service principal an Azure
|
|
10058
10058
|
Data Lake Storage Gen2 connection authenticates with and the `googleserviceaccount` key
|
|
10059
10059
|
a Google Cloud Storage connection uses), or the `awsIam` role for `auth.type` `awsiam`.
|
|
10060
|
-
Must belong to the same account as the connection
|
|
10060
|
+
Must belong to the same account as the connection — or be the iClient Celigo publishes
|
|
10061
|
+
with a pre-built OAuth HTTP connector (pre-configured by the connector; from the
|
|
10062
|
+
connecting account `GET /v1/iclients/{_id}` on it is 404 resource_not_found and
|
|
10063
|
+
`GET /v1/iclients` does not list it, yet the connection saves with it). Omit for every
|
|
10064
|
+
other auth type. On a Shopify connection `settings.appType` says which of the two it
|
|
10065
|
+
is: `public` rides Celigo's published Shopify app (installed from the Shopify App
|
|
10066
|
+
Store), `custom` rides the account's own iClient — the Shopify app the customer created
|
|
10067
|
+
in the Shopify dev dashboard — with `auth.oauth.scope` chosen on the connection. A
|
|
10068
|
+
connection with no `settings.appType` (saved before the App type existed) rides the
|
|
10069
|
+
published app when its `_iClientId` is the connector's published iClient — the form
|
|
10070
|
+
opens it with no App type selected and it keeps working — and an account-owned iClient
|
|
10071
|
+
otherwise. A saved Public App connection, with or without a stored `settings.appType`,
|
|
10072
|
+
moves to the customer's app by the same re-save: `settings.appType` `custom`, its own
|
|
10073
|
+
`_iClientId` and scopes, then authorizing; the connection form does not offer the
|
|
10074
|
+
reverse, because the Public App flow is authorized from the Shopify App Store and
|
|
10075
|
+
creates a new connection. Integration App connections (`_connectorId`) stay on Celigo's
|
|
10076
|
+
published app and carry no `settings.appType`.
|
|
10061
10077
|
examples:
|
|
10062
10078
|
- 6203a7e4f321d800129a1b8e
|
|
10063
10079
|
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).'
|
|
@@ -10078,7 +10094,20 @@ components:
|
|
|
10078
10094
|
- |-
|
|
10079
10095
|
The iClient must belong to the same account as the connection — an iClient id from
|
|
10080
10096
|
another account fails with 422 invalid_ref "The referenced IClient must belong to the
|
|
10081
|
-
same user."
|
|
10097
|
+
same user." The one exception is the iClient a pre-built OAuth HTTP connector
|
|
10098
|
+
pre-configures (Celigo's published app — the Shopify Public App's, for one): the
|
|
10099
|
+
connection saves with that id from the connecting account even though
|
|
10100
|
+
`GET /v1/iclients/{_id}` on it is 404 there, so do not refuse a `public` Shopify
|
|
10101
|
+
connection on this rule.
|
|
10102
|
+
- |-
|
|
10103
|
+
On a Shopify connection keep `settings.appType` and `_iClientId` in step the way the
|
|
10104
|
+
form does — `public` with the connector's published iClient, `custom` with an
|
|
10105
|
+
account-owned iClient: the API saves either value of `settings.appType` beside either
|
|
10106
|
+
iClient (and any other string under `settings.appType`) — nothing server-side checks
|
|
10107
|
+
the pair, so the form's rule is the only guard. On an update never drop `_iClientId` from
|
|
10108
|
+
an `auth.type` `oauth` connection: 422 invalid_field_update "Removing _iClientId is
|
|
10109
|
+
not allowed for oauth connections due to security reasons." — switch it to another
|
|
10110
|
+
iClient instead.
|
|
10082
10111
|
_httpConnectorId:
|
|
10083
10112
|
type: string
|
|
10084
10113
|
format: objectId
|