@celigo/api-specs 0.2.65 → 0.2.66

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 CHANGED
@@ -6307,6 +6307,23 @@ components:
6307
6307
  Controls the UI form layout for configuring this connection. Determines which
6308
6308
  fields are shown and how they are organized in the Celigo UI.
6309
6309
  For programmatic creation, http is the most common choice.
6310
+ x-celigo-ai-guidance:
6311
+ - |-
6312
+ The value selects a form, not a protocol: a plain `http` connection sends GraphQL requests
6313
+ identically. What `graph_ql` adds is the GraphQL editing experience — the connection form
6314
+ authors the ping as Query / Operation name / Variables fields compiled into `http.ping.body`,
6315
+ and every export and import on the connection gets a Form view toggle between the GraphQL
6316
+ editor (Query / Operation name / Variables) and the raw HTTP form.
6317
+ - |-
6318
+ A `graph_ql` connection's `baseURI` should be the GraphQL endpoint itself
6319
+ (`https://host/graphql`, `https://<store>.myshopify.com/admin/api/<version>/graphql.json`):
6320
+ the GraphQL export and import forms have no relative URI field.
6321
+ - |-
6322
+ The connection form offers no control to change this value on a connection without an HTTP
6323
+ connector, and connections cannot be cloned through the API. A user who wants the GraphQL
6324
+ editor for steps that live on an `http` connection needs a new `graph_ql` connection (same
6325
+ base URI and auth, credentials re-entered) with the steps re-pointed to it — this is the
6326
+ setup to recommend, not a product gap.
6310
6327
  x-lowercase: true
6311
6328
  examples:
6312
6329
  - http
@@ -7188,6 +7205,12 @@ components:
7188
7205
  API within the linked HTTP connector that this connection targets, for connectors that
7189
7206
  publish more than one API. Only meaningful together with `_httpConnectorId`; an id that is
7190
7207
  not one of that connector's APIs is dropped on save, not rejected.
7208
+ x-celigo-ai-guidance:
7209
+ - |-
7210
+ The connector catalog flags GraphQL APIs with `isGraphQL`. The API bound here is inherited
7211
+ by every export and import created on the connection — the step form's API type control
7212
+ is disabled once a connection is selected — so a connector's GraphQL editor requires a
7213
+ connection bound to its GraphQL API, not a per-step setting.
7191
7214
  examples:
7192
7215
  - 5d8f6a2b9c1e4f00112a3b4d
7193
7216
  _httpConnectorVersionId:
@@ -4632,6 +4632,23 @@ components:
4632
4632
  Controls the UI form layout for configuring this connection. Determines which
4633
4633
  fields are shown and how they are organized in the Celigo UI.
4634
4634
  For programmatic creation, http is the most common choice.
4635
+ x-celigo-ai-guidance:
4636
+ - |-
4637
+ The value selects a form, not a protocol: a plain `http` connection sends GraphQL requests
4638
+ identically. What `graph_ql` adds is the GraphQL editing experience — the connection form
4639
+ authors the ping as Query / Operation name / Variables fields compiled into `http.ping.body`,
4640
+ and every export and import on the connection gets a Form view toggle between the GraphQL
4641
+ editor (Query / Operation name / Variables) and the raw HTTP form.
4642
+ - |-
4643
+ A `graph_ql` connection's `baseURI` should be the GraphQL endpoint itself
4644
+ (`https://host/graphql`, `https://<store>.myshopify.com/admin/api/<version>/graphql.json`):
4645
+ the GraphQL export and import forms have no relative URI field.
4646
+ - |-
4647
+ The connection form offers no control to change this value on a connection without an HTTP
4648
+ connector, and connections cannot be cloned through the API. A user who wants the GraphQL
4649
+ editor for steps that live on an `http` connection needs a new `graph_ql` connection (same
4650
+ base URI and auth, credentials re-entered) with the steps re-pointed to it — this is the
4651
+ setup to recommend, not a product gap.
4635
4652
  x-lowercase: true
4636
4653
  examples:
4637
4654
  - http
@@ -5513,6 +5530,12 @@ components:
5513
5530
  API within the linked HTTP connector that this connection targets, for connectors that
5514
5531
  publish more than one API. Only meaningful together with `_httpConnectorId`; an id that is
5515
5532
  not one of that connector's APIs is dropped on save, not rejected.
5533
+ x-celigo-ai-guidance:
5534
+ - |-
5535
+ The connector catalog flags GraphQL APIs with `isGraphQL`. The API bound here is inherited
5536
+ by every export and import created on the connection — the step form's API type control
5537
+ is disabled once a connection is selected — so a connector's GraphQL editor requires a
5538
+ connection bound to its GraphQL API, not a per-step setting.
5516
5539
  examples:
5517
5540
  - 5d8f6a2b9c1e4f00112a3b4d
5518
5541
  _httpConnectorVersionId:
package/dist/enduser.yml CHANGED
@@ -3645,6 +3645,23 @@ components:
3645
3645
  Controls the UI form layout for configuring this connection. Determines which
3646
3646
  fields are shown and how they are organized in the Celigo UI.
3647
3647
  For programmatic creation, http is the most common choice.
3648
+ x-celigo-ai-guidance:
3649
+ - |-
3650
+ The value selects a form, not a protocol: a plain `http` connection sends GraphQL requests
3651
+ identically. What `graph_ql` adds is the GraphQL editing experience — the connection form
3652
+ authors the ping as Query / Operation name / Variables fields compiled into `http.ping.body`,
3653
+ and every export and import on the connection gets a Form view toggle between the GraphQL
3654
+ editor (Query / Operation name / Variables) and the raw HTTP form.
3655
+ - |-
3656
+ A `graph_ql` connection's `baseURI` should be the GraphQL endpoint itself
3657
+ (`https://host/graphql`, `https://<store>.myshopify.com/admin/api/<version>/graphql.json`):
3658
+ the GraphQL export and import forms have no relative URI field.
3659
+ - |-
3660
+ The connection form offers no control to change this value on a connection without an HTTP
3661
+ connector, and connections cannot be cloned through the API. A user who wants the GraphQL
3662
+ editor for steps that live on an `http` connection needs a new `graph_ql` connection (same
3663
+ base URI and auth, credentials re-entered) with the steps re-pointed to it — this is the
3664
+ setup to recommend, not a product gap.
3648
3665
  x-lowercase: true
3649
3666
  examples:
3650
3667
  - http
@@ -4526,6 +4543,12 @@ components:
4526
4543
  API within the linked HTTP connector that this connection targets, for connectors that
4527
4544
  publish more than one API. Only meaningful together with `_httpConnectorId`; an id that is
4528
4545
  not one of that connector's APIs is dropped on save, not rejected.
4546
+ x-celigo-ai-guidance:
4547
+ - |-
4548
+ The connector catalog flags GraphQL APIs with `isGraphQL`. The API bound here is inherited
4549
+ by every export and import created on the connection — the step form's API type control
4550
+ is disabled once a connection is selected — so a connector's GraphQL editor requires a
4551
+ connection bound to its GraphQL API, not a per-step setting.
4529
4552
  examples:
4530
4553
  - 5d8f6a2b9c1e4f00112a3b4d
4531
4554
  _httpConnectorVersionId:
package/dist/export.yml CHANGED
@@ -6156,6 +6156,24 @@ components:
6156
6156
  Authoring mode of the HTTP request form. Controls which editor the UI presents
6157
6157
  (standard HTTP, legacy REST, GraphQL, or connector-assistant driven) and how the
6158
6158
  request fields are interpreted. When omitted, the standard HTTP form is used.
6159
+ x-celigo-ai-guidance:
6160
+ - |-
6161
+ The value changes only the editor, never the request: the same `http.body` is sent
6162
+ identically under `http` and `graph_ql`, and the value can be changed on an existing
6163
+ export without touching the body.
6164
+ - |-
6165
+ The GraphQL form reads `http.body` as the JSON envelope `{"query", "operationName",
6166
+ "variables"}` and shows each member in its own editor, recompiling the envelope on save
6167
+ (`http.paging.body` likewise from its paging fields). A body that is not parseable JSON at
6168
+ rest — Handlebars block helpers outside a string value — renders every field EMPTY in that
6169
+ form, so keep templated variables inside a JSON string value:
6170
+ `"variables": "{\"after\": {{#if export.http.paging.token}}\"{{export.http.paging.token}}\"{{else}}null{{/if}}}"`.
6171
+ - |-
6172
+ The GraphQL form has no relative URI field: the connection `baseURI` is expected to be the
6173
+ GraphQL endpoint (a saved `relativeURI` still applies but is not shown). Create GraphQL
6174
+ exports on a `graph_ql` connection — that is the setup where the form offers the Form view
6175
+ toggle between the GraphQL editor and the raw HTTP form; a `graph_ql` export on an `http`
6176
+ connection works but cannot be switched back in the UI.
6159
6177
  examples:
6160
6178
  - http
6161
6179
  - graph_ql
@@ -6344,6 +6362,11 @@ components:
6344
6362
  - |-
6345
6363
  The body content must match the format specified in the requestMediaType field (JSON,
6346
6364
  XML, etc.).
6365
+ - |-
6366
+ A GraphQL request is this field holding the stringified JSON envelope `{"query":
6367
+ "<document>", "operationName": "...", "variables": ...}` whatever `formType` says;
6368
+ `variables` may be an object or a JSON-encoded string, and a templated variables value
6369
+ must stay inside a string so the body remains parseable JSON at rest (see `formType`).
6347
6370
  - |-
6348
6371
  You can use handlebars expressions to create dynamic content:
6349
6372
  ```
package/dist/import.yml CHANGED
@@ -1636,6 +1636,18 @@ components:
1636
1636
  - |-
1637
1637
  Use `assistant_graphql` as the default value if there is a connector available
1638
1638
  for the system and the connector supports GraphQL.
1639
+ - |-
1640
+ The value selects the editor only. Each `http.body[]` entry stays a template STRING — a
1641
+ stringified `{"query", "operationName", "variables"}` envelope, one per operation for the
1642
+ update/create pair (`http.body[0]` / `http.body[1]`); never an object entry, which is stored
1643
+ as-is and does not render. The GraphQL form parses that string to show each member in its
1644
+ own field and re-stringifies it on save; an entry that is not parseable JSON at rest renders
1645
+ those fields empty, so keep templated variables inside a JSON string value.
1646
+ - |-
1647
+ Create GraphQL imports on a `graph_ql` connection (or a connector connection bound to its
1648
+ GraphQL API): that setup offers the Form view toggle between the GraphQL editor and the
1649
+ raw HTTP form, and the GraphQL form has no relative URI field — the connection `baseURI`
1650
+ is expected to be the GraphQL endpoint.
1639
1651
  examples:
1640
1652
  - assistant
1641
1653
  - http
@@ -5455,6 +5455,23 @@ components:
5455
5455
  Controls the UI form layout for configuring this connection. Determines which
5456
5456
  fields are shown and how they are organized in the Celigo UI.
5457
5457
  For programmatic creation, http is the most common choice.
5458
+ x-celigo-ai-guidance:
5459
+ - |-
5460
+ The value selects a form, not a protocol: a plain `http` connection sends GraphQL requests
5461
+ identically. What `graph_ql` adds is the GraphQL editing experience — the connection form
5462
+ authors the ping as Query / Operation name / Variables fields compiled into `http.ping.body`,
5463
+ and every export and import on the connection gets a Form view toggle between the GraphQL
5464
+ editor (Query / Operation name / Variables) and the raw HTTP form.
5465
+ - |-
5466
+ A `graph_ql` connection's `baseURI` should be the GraphQL endpoint itself
5467
+ (`https://host/graphql`, `https://<store>.myshopify.com/admin/api/<version>/graphql.json`):
5468
+ the GraphQL export and import forms have no relative URI field.
5469
+ - |-
5470
+ The connection form offers no control to change this value on a connection without an HTTP
5471
+ connector, and connections cannot be cloned through the API. A user who wants the GraphQL
5472
+ editor for steps that live on an `http` connection needs a new `graph_ql` connection (same
5473
+ base URI and auth, credentials re-entered) with the steps re-pointed to it — this is the
5474
+ setup to recommend, not a product gap.
5458
5475
  x-lowercase: true
5459
5476
  examples:
5460
5477
  - http
@@ -6336,6 +6353,12 @@ components:
6336
6353
  API within the linked HTTP connector that this connection targets, for connectors that
6337
6354
  publish more than one API. Only meaningful together with `_httpConnectorId`; an id that is
6338
6355
  not one of that connector's APIs is dropped on save, not rejected.
6356
+ x-celigo-ai-guidance:
6357
+ - |-
6358
+ The connector catalog flags GraphQL APIs with `isGraphQL`. The API bound here is inherited
6359
+ by every export and import created on the connection — the step form's API type control
6360
+ is disabled once a connection is selected — so a connector's GraphQL editor requires a
6361
+ connection bound to its GraphQL API, not a per-step setting.
6339
6362
  examples:
6340
6363
  - 5d8f6a2b9c1e4f00112a3b4d
6341
6364
  _httpConnectorVersionId:
package/dist/tool.yml CHANGED
@@ -8056,6 +8056,23 @@ components:
8056
8056
  Controls the UI form layout for configuring this connection. Determines which
8057
8057
  fields are shown and how they are organized in the Celigo UI.
8058
8058
  For programmatic creation, http is the most common choice.
8059
+ x-celigo-ai-guidance:
8060
+ - |-
8061
+ The value selects a form, not a protocol: a plain `http` connection sends GraphQL requests
8062
+ identically. What `graph_ql` adds is the GraphQL editing experience — the connection form
8063
+ authors the ping as Query / Operation name / Variables fields compiled into `http.ping.body`,
8064
+ and every export and import on the connection gets a Form view toggle between the GraphQL
8065
+ editor (Query / Operation name / Variables) and the raw HTTP form.
8066
+ - |-
8067
+ A `graph_ql` connection's `baseURI` should be the GraphQL endpoint itself
8068
+ (`https://host/graphql`, `https://<store>.myshopify.com/admin/api/<version>/graphql.json`):
8069
+ the GraphQL export and import forms have no relative URI field.
8070
+ - |-
8071
+ The connection form offers no control to change this value on a connection without an HTTP
8072
+ connector, and connections cannot be cloned through the API. A user who wants the GraphQL
8073
+ editor for steps that live on an `http` connection needs a new `graph_ql` connection (same
8074
+ base URI and auth, credentials re-entered) with the steps re-pointed to it — this is the
8075
+ setup to recommend, not a product gap.
8059
8076
  x-lowercase: true
8060
8077
  examples:
8061
8078
  - http
@@ -8937,6 +8954,12 @@ components:
8937
8954
  API within the linked HTTP connector that this connection targets, for connectors that
8938
8955
  publish more than one API. Only meaningful together with `_httpConnectorId`; an id that is
8939
8956
  not one of that connector's APIs is dropped on save, not rejected.
8957
+ x-celigo-ai-guidance:
8958
+ - |-
8959
+ The connector catalog flags GraphQL APIs with `isGraphQL`. The API bound here is inherited
8960
+ by every export and import created on the connection — the step form's API type control
8961
+ is disabled once a connection is selected — so a connector's GraphQL editor requires a
8962
+ connection bound to its GraphQL API, not a per-step setting.
8940
8963
  examples:
8941
8964
  - 5d8f6a2b9c1e4f00112a3b4d
8942
8965
  _httpConnectorVersionId:
@@ -12158,6 +12181,18 @@ components:
12158
12181
  - |-
12159
12182
  Use `assistant_graphql` as the default value if there is a connector available
12160
12183
  for the system and the connector supports GraphQL.
12184
+ - |-
12185
+ The value selects the editor only. Each `http.body[]` entry stays a template STRING — a
12186
+ stringified `{"query", "operationName", "variables"}` envelope, one per operation for the
12187
+ update/create pair (`http.body[0]` / `http.body[1]`); never an object entry, which is stored
12188
+ as-is and does not render. The GraphQL form parses that string to show each member in its
12189
+ own field and re-stringifies it on save; an entry that is not parseable JSON at rest renders
12190
+ those fields empty, so keep templated variables inside a JSON string value.
12191
+ - |-
12192
+ Create GraphQL imports on a `graph_ql` connection (or a connector connection bound to its
12193
+ GraphQL API): that setup offers the Form view toggle between the GraphQL editor and the
12194
+ raw HTTP form, and the GraphQL form has no relative URI field — the connection `baseURI`
12195
+ is expected to be the GraphQL endpoint.
12161
12196
  examples:
12162
12197
  - assistant
12163
12198
  - http
@@ -29152,6 +29187,24 @@ components:
29152
29187
  Authoring mode of the HTTP request form. Controls which editor the UI presents
29153
29188
  (standard HTTP, legacy REST, GraphQL, or connector-assistant driven) and how the
29154
29189
  request fields are interpreted. When omitted, the standard HTTP form is used.
29190
+ x-celigo-ai-guidance:
29191
+ - |-
29192
+ The value changes only the editor, never the request: the same `http.body` is sent
29193
+ identically under `http` and `graph_ql`, and the value can be changed on an existing
29194
+ export without touching the body.
29195
+ - |-
29196
+ The GraphQL form reads `http.body` as the JSON envelope `{"query", "operationName",
29197
+ "variables"}` and shows each member in its own editor, recompiling the envelope on save
29198
+ (`http.paging.body` likewise from its paging fields). A body that is not parseable JSON at
29199
+ rest — Handlebars block helpers outside a string value — renders every field EMPTY in that
29200
+ form, so keep templated variables inside a JSON string value:
29201
+ `"variables": "{\"after\": {{#if export.http.paging.token}}\"{{export.http.paging.token}}\"{{else}}null{{/if}}}"`.
29202
+ - |-
29203
+ The GraphQL form has no relative URI field: the connection `baseURI` is expected to be the
29204
+ GraphQL endpoint (a saved `relativeURI` still applies but is not shown). Create GraphQL
29205
+ exports on a `graph_ql` connection — that is the setup where the form offers the Form view
29206
+ toggle between the GraphQL editor and the raw HTTP form; a `graph_ql` export on an `http`
29207
+ connection works but cannot be switched back in the UI.
29155
29208
  examples:
29156
29209
  - http
29157
29210
  - graph_ql
@@ -29340,6 +29393,11 @@ components:
29340
29393
  - |-
29341
29394
  The body content must match the format specified in the requestMediaType field (JSON,
29342
29395
  XML, etc.).
29396
+ - |-
29397
+ A GraphQL request is this field holding the stringified JSON envelope `{"query":
29398
+ "<document>", "operationName": "...", "variables": ...}` whatever `formType` says;
29399
+ `variables` may be an object or a JSON-encoded string, and a templated variables value
29400
+ must stay inside a string so the body remains parseable JSON at rest (see `formType`).
29343
29401
  - |-
29344
29402
  You can use handlebars expressions to create dynamic content:
29345
29403
  ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@celigo/api-specs",
3
- "version": "0.2.65",
3
+ "version": "0.2.66",
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,7 +1,7 @@
1
1
  {
2
2
  "provenance": {
3
3
  "repo": "celigo/integrator-api-specs",
4
- "iasCommit": "d4b9f7a",
4
+ "iasCommit": "0b009b6",
5
5
  "generatedAt": "2026-09-30"
6
6
  },
7
7
  "roots": {