@celigo/api-specs 0.2.32 → 0.2.33

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 CHANGED
@@ -7597,22 +7597,45 @@ components:
7597
7597
  _httpConnectorVersionId:
7598
7598
  type: string
7599
7599
  format: objectId
7600
- readOnly: true
7601
- description: Identifies the HTTP connector version used by this export. Set by the connector framework; client-supplied values are ignored (write-tested).
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. Persisted as sent on create and update; the value is not checked
7604
+ against the connection's connector.
7602
7605
  _httpConnectorResourceId:
7603
7606
  type: string
7604
7607
  format: objectId
7605
- readOnly: true
7606
- description: Identifies the HTTP connector resource used by this export. Set by the connector framework; client-supplied values are ignored (write-tested).
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. Persisted as sent; take it from the same connector blueprint as
7612
+ `_httpConnectorVersionId`.
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: Identifies the HTTP connector endpoint configuration used for this export's requests. Set by the connector framework; client-supplied values are ignored (write-tested).
7620
+ description: |-
7621
+ The connector endpoint this export calls, shown in the UI as the selected endpoint;
7622
+ `relativeURI` and `method` should match that endpoint's definition. Persisted as sent on create
7623
+ and update — the server does not verify that the endpoint belongs to the connection's connector,
7624
+ so a mismatched id pins the export to the wrong endpoint form.
7625
+ x-celigo-ai-guidance:
7626
+ - |-
7627
+ To build an export on a prebuilt connector instead of a hand-rolled HTTP request: find the
7628
+ connector in `GET /v1/httpconnectors` (match `name` or `legacyId`); read
7629
+ `GET /v1/httpconnectors/{_id}` for its `versions` (under `apis[]` for multi-API connectors);
7630
+ list resources with `GET /v1/httpconnectors/{_id}/httpconnectorresources`, then that resource's
7631
+ endpoints with `GET /v1/httpconnectors/{_id}/{_httpConnectorResourceId}/httpconnectorendpoints`
7632
+ and one endpoint's `method` and `relativeURI` with
7633
+ `GET /v1/httpconnectors/{_id}/{_httpConnectorResourceId}/{_id}`; copy that `relativeURI` and
7634
+ `method` and set `_httpConnectorVersionId`, `_httpConnectorResourceId`, and
7635
+ `_httpConnectorEndpointId` together. The export's connection must carry `http._httpConnectorId`
7636
+ for the same connector; a top-level `_httpConnectorId` on the export itself is dropped. Omit all
7637
+ three only when no published connector exists for the application. Verified against the live
7638
+ API 2026-09-21.
7616
7639
  if:
7617
7640
  properties:
7618
7641
  type:
package/dist/import.yml CHANGED
@@ -1661,14 +1661,27 @@ 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
- HTTP connector endpoint IDs used by this import (multiple endpoints for different request
1671
- types or operations). Set by the connector framework; client-supplied values are ignored.
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. Persisted
1671
+ as sent on create and update; the server does not verify that they belong to the connection's
1672
+ connector.
1673
+ x-celigo-ai-guidance:
1674
+ - |-
1675
+ To build an import on a prebuilt connector: find the connector in `GET /v1/httpconnectors`; read
1676
+ `GET /v1/httpconnectors/{_id}` for its `versions` (under `apis[]` for multi-API connectors); list
1677
+ resources with `GET /v1/httpconnectors/{_id}/httpconnectorresources` and a resource's endpoints
1678
+ with `GET /v1/httpconnectors/{_id}/{_httpConnectorResourceId}/httpconnectorendpoints`; read each
1679
+ chosen endpoint's `method` and `relativeURI` with
1680
+ `GET /v1/httpconnectors/{_id}/{_httpConnectorResourceId}/{_id}` and copy them into the positional
1681
+ arrays, one endpoint per operation; set `_httpConnectorVersionId`, `_httpConnectorResourceId`, and
1682
+ `_httpConnectorEndpointIds` together. Imports use this plural field; the singular
1683
+ `_httpConnectorEndpointId` is dropped on write. The import's connection must carry
1684
+ `http._httpConnectorId` for the same connector. Verified against the live API 2026-09-21.
1672
1685
  blobFormat:
1673
1686
  type: string
1674
1687
  enum:
@@ -1857,17 +1870,16 @@ components:
1857
1870
  // shape; do not emit it deliberately.
1858
1871
  "relativeURI": ["[\"/customers/{{{data.0.id}}}\",\"/customers\"]"]
1859
1872
  ```
1860
- ⚠️ The platform performs a URI-vs-pointer-metadata cross-check
1861
- on save: when the persisted ``relativeURI`` doesn't match the
1862
- endpoint blueprint the connector pointer fields
1863
- (``_httpConnectorId`` / ``_httpConnectorVersionId`` /
1864
- ``_httpConnectorResourceId`` / ``_httpConnectorEndpointId(s)``)
1865
- are SILENTLY UNSET so they stay in sync with future user edits.
1866
- Any malformed URI shape (stringified, wrong nesting, etc.)
1867
- therefore breaks the marketplace audit link, the UI's
1868
- assistant-view selector, and mid-build schema introspection —
1869
- the import will work at runtime but loses every "this is a
1870
- Pipedrive Persons resource" signal. Get the URI shape right.
1873
+ ⚠️ The API does NOT cross-check ``relativeURI`` / ``method`` against
1874
+ the connector pointer fields (``_httpConnectorVersionId`` /
1875
+ ``_httpConnectorResourceId`` / ``_httpConnectorEndpointIds``):
1876
+ a save whose URI does not match the pinned endpoint keeps the
1877
+ pointers exactly as sent (verified 2026-09-21 on create, on PUT,
1878
+ after 60 s, and after a no-op re-save). The consistency is yours
1879
+ to keep — copy each pinned endpoint's ``relativeURI`` and
1880
+ ``method`` into these arrays position by position, so the
1881
+ endpoint the pointers name and the request the runtime sends
1882
+ are the same one. Get the URI shape right.
1871
1883
  examples:
1872
1884
  - - /api/v1/customers
1873
1885
  - - /customers/{{{data.0.shopifyCustomerId}}}.json
@@ -1903,19 +1915,27 @@ components:
1903
1915
  _httpConnectorVersionId:
1904
1916
  type: string
1905
1917
  format: objectId
1906
- readOnly: true
1907
- description: HTTP connector version used by this import. Set by the connector framework; client-supplied values are ignored (write-tested).
1918
+ description: |-
1919
+ Pins the import to a version of the published HTTP connector its connection is bound to
1920
+ (`connection.http._httpConnectorId`), so the UI renders that connector's endpoint forms instead
1921
+ of hand-authored requests. Persisted as sent on create and update; not checked against the
1922
+ connection's connector.
1908
1923
  _httpConnectorResourceId:
1909
1924
  type: string
1910
1925
  format: objectId
1911
- readOnly: true
1912
- description: HTTP connector resource used by this import. Set by the connector framework; client-supplied values are ignored (write-tested).
1926
+ x-celigo-refModel: httpconnectorresources
1927
+ description: |-
1928
+ The connector resource (a group of related endpoints, such as Orders) that this import's
1929
+ endpoints belong to. Persisted as sent; take it from the same connector blueprint as
1930
+ `_httpConnectorVersionId`.
1913
1931
  _httpConnectorEndpointId:
1914
1932
  type: string
1915
1933
  format: objectId
1916
1934
  readOnly: true
1917
1935
  x-celigo-refModel: httpconnectorendpoints
1918
- description: HTTP connector endpoint used by this import (single endpoint). Set by the connector framework; client-supplied values are ignored (write-tested).
1936
+ description: |-
1937
+ Not used by imports: values sent on create or update are dropped, and the platform does not
1938
+ populate it. Imports bind connector endpoints per operation through `_httpConnectorEndpointIds`.
1919
1939
  body:
1920
1940
  type: array
1921
1941
  items:
package/dist/tool.yml CHANGED
@@ -10880,14 +10880,27 @@ 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
- HTTP connector endpoint IDs used by this import (multiple endpoints for different request
10890
- types or operations). Set by the connector framework; client-supplied values are ignored.
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. Persisted
10890
+ as sent on create and update; the server does not verify that they belong to the connection's
10891
+ connector.
10892
+ x-celigo-ai-guidance:
10893
+ - |-
10894
+ To build an import on a prebuilt connector: find the connector in `GET /v1/httpconnectors`; read
10895
+ `GET /v1/httpconnectors/{_id}` for its `versions` (under `apis[]` for multi-API connectors); list
10896
+ resources with `GET /v1/httpconnectors/{_id}/httpconnectorresources` and a resource's endpoints
10897
+ with `GET /v1/httpconnectors/{_id}/{_httpConnectorResourceId}/httpconnectorendpoints`; read each
10898
+ chosen endpoint's `method` and `relativeURI` with
10899
+ `GET /v1/httpconnectors/{_id}/{_httpConnectorResourceId}/{_id}` and copy them into the positional
10900
+ arrays, one endpoint per operation; set `_httpConnectorVersionId`, `_httpConnectorResourceId`, and
10901
+ `_httpConnectorEndpointIds` together. Imports use this plural field; the singular
10902
+ `_httpConnectorEndpointId` is dropped on write. The import's connection must carry
10903
+ `http._httpConnectorId` for the same connector. Verified against the live API 2026-09-21.
10891
10904
  blobFormat:
10892
10905
  type: string
10893
10906
  enum:
@@ -11076,17 +11089,16 @@ components:
11076
11089
  // shape; do not emit it deliberately.
11077
11090
  "relativeURI": ["[\"/customers/{{{data.0.id}}}\",\"/customers\"]"]
11078
11091
  ```
11079
- ⚠️ The platform performs a URI-vs-pointer-metadata cross-check
11080
- on save: when the persisted ``relativeURI`` doesn't match the
11081
- endpoint blueprint the connector pointer fields
11082
- (``_httpConnectorId`` / ``_httpConnectorVersionId`` /
11083
- ``_httpConnectorResourceId`` / ``_httpConnectorEndpointId(s)``)
11084
- are SILENTLY UNSET so they stay in sync with future user edits.
11085
- Any malformed URI shape (stringified, wrong nesting, etc.)
11086
- therefore breaks the marketplace audit link, the UI's
11087
- assistant-view selector, and mid-build schema introspection —
11088
- the import will work at runtime but loses every "this is a
11089
- Pipedrive Persons resource" signal. Get the URI shape right.
11092
+ ⚠️ The API does NOT cross-check ``relativeURI`` / ``method`` against
11093
+ the connector pointer fields (``_httpConnectorVersionId`` /
11094
+ ``_httpConnectorResourceId`` / ``_httpConnectorEndpointIds``):
11095
+ a save whose URI does not match the pinned endpoint keeps the
11096
+ pointers exactly as sent (verified 2026-09-21 on create, on PUT,
11097
+ after 60 s, and after a no-op re-save). The consistency is yours
11098
+ to keep — copy each pinned endpoint's ``relativeURI`` and
11099
+ ``method`` into these arrays position by position, so the
11100
+ endpoint the pointers name and the request the runtime sends
11101
+ are the same one. Get the URI shape right.
11090
11102
  examples:
11091
11103
  - - /api/v1/customers
11092
11104
  - - /customers/{{{data.0.shopifyCustomerId}}}.json
@@ -11122,19 +11134,27 @@ components:
11122
11134
  _httpConnectorVersionId:
11123
11135
  type: string
11124
11136
  format: objectId
11125
- readOnly: true
11126
- description: HTTP connector version used by this import. Set by the connector framework; client-supplied values are ignored (write-tested).
11137
+ description: |-
11138
+ Pins the import to a version of the published HTTP connector its connection is bound to
11139
+ (`connection.http._httpConnectorId`), so the UI renders that connector's endpoint forms instead
11140
+ of hand-authored requests. Persisted as sent on create and update; not checked against the
11141
+ connection's connector.
11127
11142
  _httpConnectorResourceId:
11128
11143
  type: string
11129
11144
  format: objectId
11130
- readOnly: true
11131
- description: HTTP connector resource used by this import. Set by the connector framework; client-supplied values are ignored (write-tested).
11145
+ x-celigo-refModel: httpconnectorresources
11146
+ description: |-
11147
+ The connector resource (a group of related endpoints, such as Orders) that this import's
11148
+ endpoints belong to. Persisted as sent; take it from the same connector blueprint as
11149
+ `_httpConnectorVersionId`.
11132
11150
  _httpConnectorEndpointId:
11133
11151
  type: string
11134
11152
  format: objectId
11135
11153
  readOnly: true
11136
11154
  x-celigo-refModel: httpconnectorendpoints
11137
- description: HTTP connector endpoint used by this import (single endpoint). Set by the connector framework; client-supplied values are ignored (write-tested).
11155
+ description: |-
11156
+ Not used by imports: values sent on create or update are dropped, and the platform does not
11157
+ populate it. Imports bind connector endpoints per operation through `_httpConnectorEndpointIds`.
11138
11158
  body:
11139
11159
  type: array
11140
11160
  items:
@@ -28136,22 +28156,45 @@ components:
28136
28156
  _httpConnectorVersionId:
28137
28157
  type: string
28138
28158
  format: objectId
28139
- readOnly: true
28140
- description: Identifies the HTTP connector version used by this export. Set by the connector framework; client-supplied values are ignored (write-tested).
28159
+ description: |-
28160
+ Pins the export to a version of the published HTTP connector its connection is bound to
28161
+ (`connection.http._httpConnectorId`), so the UI renders that connector's endpoint form instead
28162
+ of a hand-authored request. Persisted as sent on create and update; the value is not checked
28163
+ against the connection's connector.
28141
28164
  _httpConnectorResourceId:
28142
28165
  type: string
28143
28166
  format: objectId
28144
- readOnly: true
28145
- description: Identifies the HTTP connector resource used by this export. Set by the connector framework; client-supplied values are ignored (write-tested).
28167
+ x-celigo-refModel: httpconnectorresources
28168
+ description: |-
28169
+ The connector resource (a group of related endpoints, such as Orders) that this export's
28170
+ endpoint belongs to. Persisted as sent; take it from the same connector blueprint as
28171
+ `_httpConnectorVersionId`.
28146
28172
  sendAuthForFileDownloads:
28147
28173
  type: boolean
28148
28174
  description: When true, includes authentication headers when downloading files.
28149
28175
  _httpConnectorEndpointId:
28150
28176
  type: string
28151
28177
  format: objectId
28152
- readOnly: true
28153
28178
  x-celigo-refModel: httpconnectorendpoints
28154
- description: Identifies the HTTP connector endpoint configuration used for this export's requests. Set by the connector framework; client-supplied values are ignored (write-tested).
28179
+ description: |-
28180
+ The connector endpoint this export calls, shown in the UI as the selected endpoint;
28181
+ `relativeURI` and `method` should match that endpoint's definition. Persisted as sent on create
28182
+ and update — the server does not verify that the endpoint belongs to the connection's connector,
28183
+ so a mismatched id pins the export to the wrong endpoint form.
28184
+ x-celigo-ai-guidance:
28185
+ - |-
28186
+ To build an export on a prebuilt connector instead of a hand-rolled HTTP request: find the
28187
+ connector in `GET /v1/httpconnectors` (match `name` or `legacyId`); read
28188
+ `GET /v1/httpconnectors/{_id}` for its `versions` (under `apis[]` for multi-API connectors);
28189
+ list resources with `GET /v1/httpconnectors/{_id}/httpconnectorresources`, then that resource's
28190
+ endpoints with `GET /v1/httpconnectors/{_id}/{_httpConnectorResourceId}/httpconnectorendpoints`
28191
+ and one endpoint's `method` and `relativeURI` with
28192
+ `GET /v1/httpconnectors/{_id}/{_httpConnectorResourceId}/{_id}`; copy that `relativeURI` and
28193
+ `method` and set `_httpConnectorVersionId`, `_httpConnectorResourceId`, and
28194
+ `_httpConnectorEndpointId` together. The export's connection must carry `http._httpConnectorId`
28195
+ for the same connector; a top-level `_httpConnectorId` on the export itself is dropped. Omit all
28196
+ three only when no published connector exists for the application. Verified against the live
28197
+ API 2026-09-21.
28155
28198
  if:
28156
28199
  properties:
28157
28200
  type:
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@celigo/api-specs",
3
- "version": "0.2.32",
3
+ "version": "0.2.33",
4
4
  "private": false,
5
5
  "description": "Public OpenAPI bundles (dist/) and the celigo-cli lint schema pack (schemas.json).",
6
6
  "keywords": [
package/schemas.json CHANGED
@@ -1,8 +1,8 @@
1
1
  {
2
2
  "provenance": {
3
3
  "repo": "celigo/integrator-api-specs",
4
- "iasCommit": "762b9a7",
5
- "generatedAt": "2026-09-19"
4
+ "iasCommit": "99c0989",
5
+ "generatedAt": "2026-09-21"
6
6
  },
7
7
  "roots": {
8
8
  "aiagent": 133,