@celigo/api-specs 0.2.64 → 0.2.66

package/dist/api.yml

@@ -6307,6 +6307,23 @@ components:
             Controls the UI form layout for configuring this connection. Determines which
             fields are shown and how they are organized in the Celigo UI.
             For programmatic creation, http is the most common choice.
+          x-celigo-ai-guidance:
+            - |-
+              The value selects a form, not a protocol: a plain `http` connection sends GraphQL requests
+              identically. What `graph_ql` adds is the GraphQL editing experience — the connection form
+              authors the ping as Query / Operation name / Variables fields compiled into `http.ping.body`,
+              and every export and import on the connection gets a Form view toggle between the GraphQL
+              editor (Query / Operation name / Variables) and the raw HTTP form.
+            - |-
+              A `graph_ql` connection's `baseURI` should be the GraphQL endpoint itself
+              (`https://host/graphql`, `https://<store>.myshopify.com/admin/api/<version>/graphql.json`):
+              the GraphQL export and import forms have no relative URI field.
+            - |-
+              The connection form offers no control to change this value on a connection without an HTTP
+              connector, and connections cannot be cloned through the API. A user who wants the GraphQL
+              editor for steps that live on an `http` connection needs a new `graph_ql` connection (same
+              base URI and auth, credentials re-entered) with the steps re-pointed to it — this is the
+              setup to recommend, not a product gap.
           x-lowercase: true
           examples:
             - http
@@ -7188,6 +7205,12 @@ components:
             API within the linked HTTP connector that this connection targets, for connectors that
             publish more than one API. Only meaningful together with `_httpConnectorId`; an id that is
             not one of that connector's APIs is dropped on save, not rejected.
+          x-celigo-ai-guidance:
+            - |-
+              The connector catalog flags GraphQL APIs with `isGraphQL`. The API bound here is inherited
+              by every export and import created on the connection — the step form's API type control
+              is disabled once a connection is selected — so a connector's GraphQL editor requires a
+              connection bound to its GraphQL API, not a per-step setting.
           examples:
             - 5d8f6a2b9c1e4f00112a3b4d
         _httpConnectorVersionId:

package/dist/connection.yml

@@ -4632,6 +4632,23 @@ components:
             Controls the UI form layout for configuring this connection. Determines which
             fields are shown and how they are organized in the Celigo UI.
             For programmatic creation, http is the most common choice.
+          x-celigo-ai-guidance:
+            - |-
+              The value selects a form, not a protocol: a plain `http` connection sends GraphQL requests
+              identically. What `graph_ql` adds is the GraphQL editing experience — the connection form
+              authors the ping as Query / Operation name / Variables fields compiled into `http.ping.body`,
+              and every export and import on the connection gets a Form view toggle between the GraphQL
+              editor (Query / Operation name / Variables) and the raw HTTP form.
+            - |-
+              A `graph_ql` connection's `baseURI` should be the GraphQL endpoint itself
+              (`https://host/graphql`, `https://<store>.myshopify.com/admin/api/<version>/graphql.json`):
+              the GraphQL export and import forms have no relative URI field.
+            - |-
+              The connection form offers no control to change this value on a connection without an HTTP
+              connector, and connections cannot be cloned through the API. A user who wants the GraphQL
+              editor for steps that live on an `http` connection needs a new `graph_ql` connection (same
+              base URI and auth, credentials re-entered) with the steps re-pointed to it — this is the
+              setup to recommend, not a product gap.
           x-lowercase: true
           examples:
             - http
@@ -5513,6 +5530,12 @@ components:
             API within the linked HTTP connector that this connection targets, for connectors that
             publish more than one API. Only meaningful together with `_httpConnectorId`; an id that is
             not one of that connector's APIs is dropped on save, not rejected.
+          x-celigo-ai-guidance:
+            - |-
+              The connector catalog flags GraphQL APIs with `isGraphQL`. The API bound here is inherited
+              by every export and import created on the connection — the step form's API type control
+              is disabled once a connection is selected — so a connector's GraphQL editor requires a
+              connection bound to its GraphQL API, not a per-step setting.
           examples:
             - 5d8f6a2b9c1e4f00112a3b4d
         _httpConnectorVersionId:

package/dist/enduser.yml

@@ -3645,6 +3645,23 @@ components:
             Controls the UI form layout for configuring this connection. Determines which
             fields are shown and how they are organized in the Celigo UI.
             For programmatic creation, http is the most common choice.
+          x-celigo-ai-guidance:
+            - |-
+              The value selects a form, not a protocol: a plain `http` connection sends GraphQL requests
+              identically. What `graph_ql` adds is the GraphQL editing experience — the connection form
+              authors the ping as Query / Operation name / Variables fields compiled into `http.ping.body`,
+              and every export and import on the connection gets a Form view toggle between the GraphQL
+              editor (Query / Operation name / Variables) and the raw HTTP form.
+            - |-
+              A `graph_ql` connection's `baseURI` should be the GraphQL endpoint itself
+              (`https://host/graphql`, `https://<store>.myshopify.com/admin/api/<version>/graphql.json`):
+              the GraphQL export and import forms have no relative URI field.
+            - |-
+              The connection form offers no control to change this value on a connection without an HTTP
+              connector, and connections cannot be cloned through the API. A user who wants the GraphQL
+              editor for steps that live on an `http` connection needs a new `graph_ql` connection (same
+              base URI and auth, credentials re-entered) with the steps re-pointed to it — this is the
+              setup to recommend, not a product gap.
           x-lowercase: true
           examples:
             - http
@@ -4526,6 +4543,12 @@ components:
             API within the linked HTTP connector that this connection targets, for connectors that
             publish more than one API. Only meaningful together with `_httpConnectorId`; an id that is
             not one of that connector's APIs is dropped on save, not rejected.
+          x-celigo-ai-guidance:
+            - |-
+              The connector catalog flags GraphQL APIs with `isGraphQL`. The API bound here is inherited
+              by every export and import created on the connection — the step form's API type control
+              is disabled once a connection is selected — so a connector's GraphQL editor requires a
+              connection bound to its GraphQL API, not a per-step setting.
           examples:
             - 5d8f6a2b9c1e4f00112a3b4d
         _httpConnectorVersionId:

package/dist/export.yml

@@ -6156,6 +6156,24 @@ components:
             Authoring mode of the HTTP request form. Controls which editor the UI presents
             (standard HTTP, legacy REST, GraphQL, or connector-assistant driven) and how the
             request fields are interpreted. When omitted, the standard HTTP form is used.
+          x-celigo-ai-guidance:
+            - |-
+              The value changes only the editor, never the request: the same `http.body` is sent
+              identically under `http` and `graph_ql`, and the value can be changed on an existing
+              export without touching the body.
+            - |-
+              The GraphQL form reads `http.body` as the JSON envelope `{"query", "operationName",
+              "variables"}` and shows each member in its own editor, recompiling the envelope on save
+              (`http.paging.body` likewise from its paging fields). A body that is not parseable JSON at
+              rest — Handlebars block helpers outside a string value — renders every field EMPTY in that
+              form, so keep templated variables inside a JSON string value:
+              `"variables": "{\"after\": {{#if export.http.paging.token}}\"{{export.http.paging.token}}\"{{else}}null{{/if}}}"`.
+            - |-
+              The GraphQL form has no relative URI field: the connection `baseURI` is expected to be the
+              GraphQL endpoint (a saved `relativeURI` still applies but is not shown). Create GraphQL
+              exports on a `graph_ql` connection — that is the setup where the form offers the Form view
+              toggle between the GraphQL editor and the raw HTTP form; a `graph_ql` export on an `http`
+              connection works but cannot be switched back in the UI.
           examples:
             - http
             - graph_ql
@@ -6344,6 +6362,11 @@ components:
             - |-
               The body content must match the format specified in the requestMediaType field (JSON,
               XML, etc.).
+            - |-
+              A GraphQL request is this field holding the stringified JSON envelope `{"query":
+              "<document>", "operationName": "...", "variables": ...}` whatever `formType` says;
+              `variables` may be an object or a JSON-encoded string, and a templated variables value
+              must stay inside a string so the body remains parseable JSON at rest (see `formType`).
             - |-
               You can use handlebars expressions to create dynamic content:
               ```

package/dist/import.yml

@@ -1636,6 +1636,18 @@ components:
             - |-
               Use `assistant_graphql` as the default value if there is a connector available
               for the system and the connector supports GraphQL.
+            - |-
+              The value selects the editor only. Each `http.body[]` entry stays a template STRING — a
+              stringified `{"query", "operationName", "variables"}` envelope, one per operation for the
+              update/create pair (`http.body[0]` / `http.body[1]`); never an object entry, which is stored
+              as-is and does not render. The GraphQL form parses that string to show each member in its
+              own field and re-stringifies it on save; an entry that is not parseable JSON at rest renders
+              those fields empty, so keep templated variables inside a JSON string value.
+            - |-
+              Create GraphQL imports on a `graph_ql` connection (or a connector connection bound to its
+              GraphQL API): that setup offers the Form view toggle between the GraphQL editor and the
+              raw HTTP form, and the GraphQL form has no relative URI field — the connection `baseURI`
+              is expected to be the GraphQL endpoint.
           examples:
             - assistant
             - http

package/dist/mcp-server.yml

@@ -5455,6 +5455,23 @@ components:
             Controls the UI form layout for configuring this connection. Determines which
             fields are shown and how they are organized in the Celigo UI.
             For programmatic creation, http is the most common choice.
+          x-celigo-ai-guidance:
+            - |-
+              The value selects a form, not a protocol: a plain `http` connection sends GraphQL requests
+              identically. What `graph_ql` adds is the GraphQL editing experience — the connection form
+              authors the ping as Query / Operation name / Variables fields compiled into `http.ping.body`,
+              and every export and import on the connection gets a Form view toggle between the GraphQL
+              editor (Query / Operation name / Variables) and the raw HTTP form.
+            - |-
+              A `graph_ql` connection's `baseURI` should be the GraphQL endpoint itself
+              (`https://host/graphql`, `https://<store>.myshopify.com/admin/api/<version>/graphql.json`):
+              the GraphQL export and import forms have no relative URI field.
+            - |-
+              The connection form offers no control to change this value on a connection without an HTTP
+              connector, and connections cannot be cloned through the API. A user who wants the GraphQL
+              editor for steps that live on an `http` connection needs a new `graph_ql` connection (same
+              base URI and auth, credentials re-entered) with the steps re-pointed to it — this is the
+              setup to recommend, not a product gap.
           x-lowercase: true
           examples:
             - http
@@ -6336,6 +6353,12 @@ components:
             API within the linked HTTP connector that this connection targets, for connectors that
             publish more than one API. Only meaningful together with `_httpConnectorId`; an id that is
             not one of that connector's APIs is dropped on save, not rejected.
+          x-celigo-ai-guidance:
+            - |-
+              The connector catalog flags GraphQL APIs with `isGraphQL`. The API bound here is inherited
+              by every export and import created on the connection — the step form's API type control
+              is disabled once a connection is selected — so a connector's GraphQL editor requires a
+              connection bound to its GraphQL API, not a per-step setting.
           examples:
             - 5d8f6a2b9c1e4f00112a3b4d
         _httpConnectorVersionId: