@celigo/api-specs 0.2.32 → 0.2.34
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/export.yml +33 -6
- package/dist/import.yml +43 -19
- package/dist/tool.yml +76 -25
- package/package.json +1 -1
- package/schemas.json +2 -2
package/dist/export.yml
CHANGED
|
@@ -7597,22 +7597,49 @@ components:
|
|
|
7597
7597
|
_httpConnectorVersionId:
|
|
7598
7598
|
type: string
|
|
7599
7599
|
format: objectId
|
|
7600
|
-
|
|
7601
|
-
|
|
7600
|
+
description: |-
|
|
7601
|
+
Pins the export to a version of the published HTTP connector its connection is bound to
|
|
7602
|
+
(`connection.http._httpConnectorId`), so the UI renders that connector's endpoint form instead
|
|
7603
|
+
of a hand-authored request. Linked on save together with `_httpConnectorResourceId` and
|
|
7604
|
+
`_httpConnectorEndpointId` — see that field for the rule.
|
|
7602
7605
|
_httpConnectorResourceId:
|
|
7603
7606
|
type: string
|
|
7604
7607
|
format: objectId
|
|
7605
|
-
|
|
7606
|
-
description:
|
|
7608
|
+
x-celigo-refModel: httpconnectorresources
|
|
7609
|
+
description: |-
|
|
7610
|
+
The connector resource (a group of related endpoints, such as Orders) that this export's
|
|
7611
|
+
endpoint belongs to. Linked on save together with `_httpConnectorEndpointId` — see that field
|
|
7612
|
+
for the rule.
|
|
7607
7613
|
sendAuthForFileDownloads:
|
|
7608
7614
|
type: boolean
|
|
7609
7615
|
description: When true, includes authentication headers when downloading files.
|
|
7610
7616
|
_httpConnectorEndpointId:
|
|
7611
7617
|
type: string
|
|
7612
7618
|
format: objectId
|
|
7613
|
-
readOnly: true
|
|
7614
7619
|
x-celigo-refModel: httpconnectorendpoints
|
|
7615
|
-
description:
|
|
7620
|
+
description: |-
|
|
7621
|
+
The connector endpoint this export calls, shown in the UI as the selected endpoint. On save the
|
|
7622
|
+
platform derives it (with the version and resource ids) from `relativeURI` and `method` when
|
|
7623
|
+
they match an endpoint of the connector the connection is bound to — path parameters, literal
|
|
7624
|
+
ids and query strings still match — and replaces ids that belong to another connector. An id for
|
|
7625
|
+
the connection's own connector is kept as sent even when the URI names a different endpoint;
|
|
7626
|
+
when nothing matches, or the connection has no connector, whatever was sent is kept and nothing
|
|
7627
|
+
is derived.
|
|
7628
|
+
x-celigo-ai-guidance:
|
|
7629
|
+
- |-
|
|
7630
|
+
To build an export on a prebuilt connector instead of a hand-rolled HTTP request, bind the
|
|
7631
|
+
CONNECTION (`http._httpConnectorId` — find the connector in `GET /v1/httpconnectors` by `name`
|
|
7632
|
+
or `legacyId`) and write the endpoint's `relativeURI` and `method`; the platform links the
|
|
7633
|
+
export to that endpoint on save, so the three pointer fields may be omitted. Read the saved
|
|
7634
|
+
export back: no pointers means the URI matched no endpoint of the connection's connector. Set
|
|
7635
|
+
`_httpConnectorVersionId`, `_httpConnectorResourceId` and `_httpConnectorEndpointId` together
|
|
7636
|
+
only to pin a same-connector endpoint the URI would not match. Endpoint discovery through the
|
|
7637
|
+
published operations: `GET /v1/httpconnectors/{_id}` (`versions`, under `apis[]` for
|
|
7638
|
+
multi-API connectors), `GET /v1/httpconnectors/{_id}/httpconnectorresources`,
|
|
7639
|
+
`GET /v1/httpconnectors/{_id}/{_httpConnectorResourceId}/httpconnectorendpoints`, and
|
|
7640
|
+
`GET /v1/httpconnectors/{_id}/{_httpConnectorResourceId}/{_id}` for an endpoint's `method` and
|
|
7641
|
+
`relativeURI`. A top-level `_httpConnectorId` on the export itself is dropped. Verified against
|
|
7642
|
+
the live API 2026-09-21.
|
|
7616
7643
|
if:
|
|
7617
7644
|
properties:
|
|
7618
7645
|
type:
|
package/dist/import.yml
CHANGED
|
@@ -1661,14 +1661,30 @@ components:
|
|
|
1661
1661
|
- xml
|
|
1662
1662
|
_httpConnectorEndpointIds:
|
|
1663
1663
|
type: array
|
|
1664
|
-
readOnly: true
|
|
1665
1664
|
items:
|
|
1666
1665
|
type: string
|
|
1667
1666
|
format: objectId
|
|
1668
1667
|
x-celigo-refModel: httpconnectorendpoints
|
|
1669
1668
|
description: |-
|
|
1670
|
-
|
|
1671
|
-
|
|
1669
|
+
The connector endpoints this import calls, one per entry of `relativeURI` / `method` (for
|
|
1670
|
+
example a CREATE and an UPDATE endpoint), shown in the UI as the selected endpoints. On save the
|
|
1671
|
+
platform derives them (with the version and resource ids) from each `relativeURI` / `method`
|
|
1672
|
+
pair that matches an endpoint of the connector the connection is bound to, and replaces ids
|
|
1673
|
+
that belong to another connector; ids for the connection's own connector are kept as sent, and
|
|
1674
|
+
when nothing matches, or the connection has no connector, whatever was sent is kept.
|
|
1675
|
+
x-celigo-ai-guidance:
|
|
1676
|
+
- |-
|
|
1677
|
+
To build an import on a prebuilt connector, bind the CONNECTION (`http._httpConnectorId`) and
|
|
1678
|
+
write each operation's `relativeURI` and `method` into the positional arrays; the platform links
|
|
1679
|
+
the import to those endpoints on save, so the pointer fields may be omitted. Read the saved
|
|
1680
|
+
import back: missing entries mean a URI matched no endpoint of the connection's connector. Set
|
|
1681
|
+
`_httpConnectorVersionId`, `_httpConnectorResourceId` and `_httpConnectorEndpointIds` together
|
|
1682
|
+
only to pin same-connector endpoints the URIs would not match. Imports use this plural field;
|
|
1683
|
+
the singular `_httpConnectorEndpointId` is dropped on write. Endpoint discovery through the
|
|
1684
|
+
published operations: `GET /v1/httpconnectors/{_id}`, `…/{_id}/httpconnectorresources`,
|
|
1685
|
+
`…/{_id}/{_httpConnectorResourceId}/httpconnectorendpoints`, and
|
|
1686
|
+
`…/{_id}/{_httpConnectorResourceId}/{_id}` for an endpoint's `method` and `relativeURI`.
|
|
1687
|
+
Verified against the live API 2026-09-21.
|
|
1672
1688
|
blobFormat:
|
|
1673
1689
|
type: string
|
|
1674
1690
|
enum:
|
|
@@ -1857,17 +1873,17 @@ components:
|
|
|
1857
1873
|
// shape; do not emit it deliberately.
|
|
1858
1874
|
"relativeURI": ["[\"/customers/{{{data.0.id}}}\",\"/customers\"]"]
|
|
1859
1875
|
```
|
|
1860
|
-
⚠️
|
|
1861
|
-
|
|
1862
|
-
|
|
1863
|
-
|
|
1864
|
-
|
|
1865
|
-
|
|
1866
|
-
|
|
1867
|
-
|
|
1868
|
-
|
|
1869
|
-
|
|
1870
|
-
|
|
1876
|
+
⚠️ On save the platform derives the connector pointer fields
|
|
1877
|
+
(``_httpConnectorVersionId`` / ``_httpConnectorResourceId`` /
|
|
1878
|
+
``_httpConnectorEndpointIds``) from each ``relativeURI`` /
|
|
1879
|
+
``method`` pair that matches an endpoint of the connector the
|
|
1880
|
+
connection is bound to (path parameters and query strings still
|
|
1881
|
+
match); pointers you send for that connector are kept, pointers
|
|
1882
|
+
from another connector are replaced, and a URI that matches
|
|
1883
|
+
nothing leaves whatever you sent in place — nothing is unset
|
|
1884
|
+
(verified 2026-09-21 on create, on PUT, and after a re-save). Keep
|
|
1885
|
+
each entry equal to the endpoint you mean so the pointer and the
|
|
1886
|
+
request agree. Get the URI shape right.
|
|
1871
1887
|
examples:
|
|
1872
1888
|
- - /api/v1/customers
|
|
1873
1889
|
- - /customers/{{{data.0.shopifyCustomerId}}}.json
|
|
@@ -1903,19 +1919,27 @@ components:
|
|
|
1903
1919
|
_httpConnectorVersionId:
|
|
1904
1920
|
type: string
|
|
1905
1921
|
format: objectId
|
|
1906
|
-
|
|
1907
|
-
|
|
1922
|
+
description: |-
|
|
1923
|
+
Pins the import to a version of the published HTTP connector its connection is bound to
|
|
1924
|
+
(`connection.http._httpConnectorId`), so the UI renders that connector's endpoint forms instead
|
|
1925
|
+
of hand-authored requests. Linked on save together with `_httpConnectorResourceId` and
|
|
1926
|
+
`_httpConnectorEndpointIds` — see that field for the rule.
|
|
1908
1927
|
_httpConnectorResourceId:
|
|
1909
1928
|
type: string
|
|
1910
1929
|
format: objectId
|
|
1911
|
-
|
|
1912
|
-
description:
|
|
1930
|
+
x-celigo-refModel: httpconnectorresources
|
|
1931
|
+
description: |-
|
|
1932
|
+
The connector resource (a group of related endpoints, such as Orders) that this import's
|
|
1933
|
+
endpoints belong to. Linked on save together with `_httpConnectorEndpointIds` — see that field
|
|
1934
|
+
for the rule.
|
|
1913
1935
|
_httpConnectorEndpointId:
|
|
1914
1936
|
type: string
|
|
1915
1937
|
format: objectId
|
|
1916
1938
|
readOnly: true
|
|
1917
1939
|
x-celigo-refModel: httpconnectorendpoints
|
|
1918
|
-
description:
|
|
1940
|
+
description: |-
|
|
1941
|
+
Not used by imports: values sent on create or update are dropped, and the platform does not
|
|
1942
|
+
populate it. Imports bind connector endpoints per operation through `_httpConnectorEndpointIds`.
|
|
1919
1943
|
body:
|
|
1920
1944
|
type: array
|
|
1921
1945
|
items:
|
package/dist/tool.yml
CHANGED
|
@@ -10880,14 +10880,30 @@ components:
|
|
|
10880
10880
|
- xml
|
|
10881
10881
|
_httpConnectorEndpointIds:
|
|
10882
10882
|
type: array
|
|
10883
|
-
readOnly: true
|
|
10884
10883
|
items:
|
|
10885
10884
|
type: string
|
|
10886
10885
|
format: objectId
|
|
10887
10886
|
x-celigo-refModel: httpconnectorendpoints
|
|
10888
10887
|
description: |-
|
|
10889
|
-
|
|
10890
|
-
|
|
10888
|
+
The connector endpoints this import calls, one per entry of `relativeURI` / `method` (for
|
|
10889
|
+
example a CREATE and an UPDATE endpoint), shown in the UI as the selected endpoints. On save the
|
|
10890
|
+
platform derives them (with the version and resource ids) from each `relativeURI` / `method`
|
|
10891
|
+
pair that matches an endpoint of the connector the connection is bound to, and replaces ids
|
|
10892
|
+
that belong to another connector; ids for the connection's own connector are kept as sent, and
|
|
10893
|
+
when nothing matches, or the connection has no connector, whatever was sent is kept.
|
|
10894
|
+
x-celigo-ai-guidance:
|
|
10895
|
+
- |-
|
|
10896
|
+
To build an import on a prebuilt connector, bind the CONNECTION (`http._httpConnectorId`) and
|
|
10897
|
+
write each operation's `relativeURI` and `method` into the positional arrays; the platform links
|
|
10898
|
+
the import to those endpoints on save, so the pointer fields may be omitted. Read the saved
|
|
10899
|
+
import back: missing entries mean a URI matched no endpoint of the connection's connector. Set
|
|
10900
|
+
`_httpConnectorVersionId`, `_httpConnectorResourceId` and `_httpConnectorEndpointIds` together
|
|
10901
|
+
only to pin same-connector endpoints the URIs would not match. Imports use this plural field;
|
|
10902
|
+
the singular `_httpConnectorEndpointId` is dropped on write. Endpoint discovery through the
|
|
10903
|
+
published operations: `GET /v1/httpconnectors/{_id}`, `…/{_id}/httpconnectorresources`,
|
|
10904
|
+
`…/{_id}/{_httpConnectorResourceId}/httpconnectorendpoints`, and
|
|
10905
|
+
`…/{_id}/{_httpConnectorResourceId}/{_id}` for an endpoint's `method` and `relativeURI`.
|
|
10906
|
+
Verified against the live API 2026-09-21.
|
|
10891
10907
|
blobFormat:
|
|
10892
10908
|
type: string
|
|
10893
10909
|
enum:
|
|
@@ -11076,17 +11092,17 @@ components:
|
|
|
11076
11092
|
// shape; do not emit it deliberately.
|
|
11077
11093
|
"relativeURI": ["[\"/customers/{{{data.0.id}}}\",\"/customers\"]"]
|
|
11078
11094
|
```
|
|
11079
|
-
⚠️
|
|
11080
|
-
|
|
11081
|
-
|
|
11082
|
-
|
|
11083
|
-
|
|
11084
|
-
|
|
11085
|
-
|
|
11086
|
-
|
|
11087
|
-
|
|
11088
|
-
|
|
11089
|
-
|
|
11095
|
+
⚠️ On save the platform derives the connector pointer fields
|
|
11096
|
+
(``_httpConnectorVersionId`` / ``_httpConnectorResourceId`` /
|
|
11097
|
+
``_httpConnectorEndpointIds``) from each ``relativeURI`` /
|
|
11098
|
+
``method`` pair that matches an endpoint of the connector the
|
|
11099
|
+
connection is bound to (path parameters and query strings still
|
|
11100
|
+
match); pointers you send for that connector are kept, pointers
|
|
11101
|
+
from another connector are replaced, and a URI that matches
|
|
11102
|
+
nothing leaves whatever you sent in place — nothing is unset
|
|
11103
|
+
(verified 2026-09-21 on create, on PUT, and after a re-save). Keep
|
|
11104
|
+
each entry equal to the endpoint you mean so the pointer and the
|
|
11105
|
+
request agree. Get the URI shape right.
|
|
11090
11106
|
examples:
|
|
11091
11107
|
- - /api/v1/customers
|
|
11092
11108
|
- - /customers/{{{data.0.shopifyCustomerId}}}.json
|
|
@@ -11122,19 +11138,27 @@ components:
|
|
|
11122
11138
|
_httpConnectorVersionId:
|
|
11123
11139
|
type: string
|
|
11124
11140
|
format: objectId
|
|
11125
|
-
|
|
11126
|
-
|
|
11141
|
+
description: |-
|
|
11142
|
+
Pins the import to a version of the published HTTP connector its connection is bound to
|
|
11143
|
+
(`connection.http._httpConnectorId`), so the UI renders that connector's endpoint forms instead
|
|
11144
|
+
of hand-authored requests. Linked on save together with `_httpConnectorResourceId` and
|
|
11145
|
+
`_httpConnectorEndpointIds` — see that field for the rule.
|
|
11127
11146
|
_httpConnectorResourceId:
|
|
11128
11147
|
type: string
|
|
11129
11148
|
format: objectId
|
|
11130
|
-
|
|
11131
|
-
description:
|
|
11149
|
+
x-celigo-refModel: httpconnectorresources
|
|
11150
|
+
description: |-
|
|
11151
|
+
The connector resource (a group of related endpoints, such as Orders) that this import's
|
|
11152
|
+
endpoints belong to. Linked on save together with `_httpConnectorEndpointIds` — see that field
|
|
11153
|
+
for the rule.
|
|
11132
11154
|
_httpConnectorEndpointId:
|
|
11133
11155
|
type: string
|
|
11134
11156
|
format: objectId
|
|
11135
11157
|
readOnly: true
|
|
11136
11158
|
x-celigo-refModel: httpconnectorendpoints
|
|
11137
|
-
description:
|
|
11159
|
+
description: |-
|
|
11160
|
+
Not used by imports: values sent on create or update are dropped, and the platform does not
|
|
11161
|
+
populate it. Imports bind connector endpoints per operation through `_httpConnectorEndpointIds`.
|
|
11138
11162
|
body:
|
|
11139
11163
|
type: array
|
|
11140
11164
|
items:
|
|
@@ -28136,22 +28160,49 @@ components:
|
|
|
28136
28160
|
_httpConnectorVersionId:
|
|
28137
28161
|
type: string
|
|
28138
28162
|
format: objectId
|
|
28139
|
-
|
|
28140
|
-
|
|
28163
|
+
description: |-
|
|
28164
|
+
Pins the export to a version of the published HTTP connector its connection is bound to
|
|
28165
|
+
(`connection.http._httpConnectorId`), so the UI renders that connector's endpoint form instead
|
|
28166
|
+
of a hand-authored request. Linked on save together with `_httpConnectorResourceId` and
|
|
28167
|
+
`_httpConnectorEndpointId` — see that field for the rule.
|
|
28141
28168
|
_httpConnectorResourceId:
|
|
28142
28169
|
type: string
|
|
28143
28170
|
format: objectId
|
|
28144
|
-
|
|
28145
|
-
description:
|
|
28171
|
+
x-celigo-refModel: httpconnectorresources
|
|
28172
|
+
description: |-
|
|
28173
|
+
The connector resource (a group of related endpoints, such as Orders) that this export's
|
|
28174
|
+
endpoint belongs to. Linked on save together with `_httpConnectorEndpointId` — see that field
|
|
28175
|
+
for the rule.
|
|
28146
28176
|
sendAuthForFileDownloads:
|
|
28147
28177
|
type: boolean
|
|
28148
28178
|
description: When true, includes authentication headers when downloading files.
|
|
28149
28179
|
_httpConnectorEndpointId:
|
|
28150
28180
|
type: string
|
|
28151
28181
|
format: objectId
|
|
28152
|
-
readOnly: true
|
|
28153
28182
|
x-celigo-refModel: httpconnectorendpoints
|
|
28154
|
-
description:
|
|
28183
|
+
description: |-
|
|
28184
|
+
The connector endpoint this export calls, shown in the UI as the selected endpoint. On save the
|
|
28185
|
+
platform derives it (with the version and resource ids) from `relativeURI` and `method` when
|
|
28186
|
+
they match an endpoint of the connector the connection is bound to — path parameters, literal
|
|
28187
|
+
ids and query strings still match — and replaces ids that belong to another connector. An id for
|
|
28188
|
+
the connection's own connector is kept as sent even when the URI names a different endpoint;
|
|
28189
|
+
when nothing matches, or the connection has no connector, whatever was sent is kept and nothing
|
|
28190
|
+
is derived.
|
|
28191
|
+
x-celigo-ai-guidance:
|
|
28192
|
+
- |-
|
|
28193
|
+
To build an export on a prebuilt connector instead of a hand-rolled HTTP request, bind the
|
|
28194
|
+
CONNECTION (`http._httpConnectorId` — find the connector in `GET /v1/httpconnectors` by `name`
|
|
28195
|
+
or `legacyId`) and write the endpoint's `relativeURI` and `method`; the platform links the
|
|
28196
|
+
export to that endpoint on save, so the three pointer fields may be omitted. Read the saved
|
|
28197
|
+
export back: no pointers means the URI matched no endpoint of the connection's connector. Set
|
|
28198
|
+
`_httpConnectorVersionId`, `_httpConnectorResourceId` and `_httpConnectorEndpointId` together
|
|
28199
|
+
only to pin a same-connector endpoint the URI would not match. Endpoint discovery through the
|
|
28200
|
+
published operations: `GET /v1/httpconnectors/{_id}` (`versions`, under `apis[]` for
|
|
28201
|
+
multi-API connectors), `GET /v1/httpconnectors/{_id}/httpconnectorresources`,
|
|
28202
|
+
`GET /v1/httpconnectors/{_id}/{_httpConnectorResourceId}/httpconnectorendpoints`, and
|
|
28203
|
+
`GET /v1/httpconnectors/{_id}/{_httpConnectorResourceId}/{_id}` for an endpoint's `method` and
|
|
28204
|
+
`relativeURI`. A top-level `_httpConnectorId` on the export itself is dropped. Verified against
|
|
28205
|
+
the live API 2026-09-21.
|
|
28155
28206
|
if:
|
|
28156
28207
|
properties:
|
|
28157
28208
|
type:
|
package/package.json
CHANGED