@celigo/api-specs 0.2.136 → 0.2.138

package/dist/api.yml

@@ -4724,21 +4724,11 @@ components:
           format: objectId
           x-celigo-refModel: connectors
           readOnly: true
-          description: |
-            Reference to the integration app that defines this resource.
-
-            This field is only populated for resources that are part of an integration app.
-            It contains the unique identifier (_id) of the integration app (connector)
-            that defines the structure, behavior, and templates for this resource.
-
-            The integration app is the published template that can be installed
-            multiple times across different accounts, with each installation creating
-            a separate integration instance (referenced by _integrationId).
-
-            This reference enables:
-            - Identifying the source integration app for this resource
-            - Determining which template version is being used
-            - Linking to documentation, support, and marketplace information
+          description: |-
+            Integration App (connector) that defines this resource. Present only on resources an
+            Integration App owns. The app locks parts of these documents, and a PUT that changes a
+            locked field answers 200 but keeps the stored value, so read the document back to confirm
+            a change.
           examples:
             - 5e8d43a1b9e5a80011a35f1b
           x-celigo-ai-guidance:

package/dist/asynchelper.yml

@@ -3482,21 +3482,11 @@ components:
           format: objectId
           x-celigo-refModel: connectors
           readOnly: true
-          description: |
-            Reference to the integration app that defines this resource.
-
-            This field is only populated for resources that are part of an integration app.
-            It contains the unique identifier (_id) of the integration app (connector)
-            that defines the structure, behavior, and templates for this resource.
-
-            The integration app is the published template that can be installed
-            multiple times across different accounts, with each installation creating
-            a separate integration instance (referenced by _integrationId).
-
-            This reference enables:
-            - Identifying the source integration app for this resource
-            - Determining which template version is being used
-            - Linking to documentation, support, and marketplace information
+          description: |-
+            Integration App (connector) that defines this resource. Present only on resources an
+            Integration App owns. The app locks parts of these documents, and a PUT that changes a
+            locked field answers 200 but keeps the stored value, so read the document back to confirm
+            a change.
           examples:
             - 5e8d43a1b9e5a80011a35f1b
           x-celigo-ai-guidance:

package/dist/connection.yml

@@ -3836,21 +3836,11 @@ components:
           format: objectId
           x-celigo-refModel: connectors
           readOnly: true
-          description: |
-            Reference to the integration app that defines this resource.
-
-            This field is only populated for resources that are part of an integration app.
-            It contains the unique identifier (_id) of the integration app (connector)
-            that defines the structure, behavior, and templates for this resource.
-
-            The integration app is the published template that can be installed
-            multiple times across different accounts, with each installation creating
-            a separate integration instance (referenced by _integrationId).
-
-            This reference enables:
-            - Identifying the source integration app for this resource
-            - Determining which template version is being used
-            - Linking to documentation, support, and marketplace information
+          description: |-
+            Integration App (connector) that defines this resource. Present only on resources an
+            Integration App owns. The app locks parts of these documents, and a PUT that changes a
+            locked field answers 200 but keeps the stored value, so read the document back to confirm
+            a change.
           examples:
             - 5e8d43a1b9e5a80011a35f1b
           x-celigo-ai-guidance:

package/dist/ediprofile.yml

@@ -409,13 +409,19 @@ components:
             - edifact
         tpInterchangeId:
           type: string
-          description: Trading partner's interchange identifier (ISA06 for X12, UNB sender/receiver ID for EDIFACT)
+          description: |-
+            Trading partner's interchange identifier: the sender ID on files the partner sends and the
+            receiver ID on files you send (X12 ISA06 and ISA08 respectively; the UNB sender and
+            recipient in EDIFACT).
           examples:
             - ACMECORP
             - '5412345678901'
         myInterchangeId:
           type: string
-          description: Your (sender/receiver) interchange identifier
+          description: |-
+            Your interchange identifier: the receiver ID on files the partner sends and the sender ID
+            on files you send (X12 ISA08 and ISA06 respectively; the UNB recipient and sender in
+            EDIFACT).
           examples:
             - MYCOMPANY
             - '1234567890123'
@@ -453,9 +459,12 @@ components:
             - '00'
         isa02:
           type: string
-          description: X12 ISA02 - Authorization Information (10 characters)
+          description: |-
+            X12 ISA02 — Authorization Information. When parsing, an inbound file's ISA02 must match
+            this value after trimming (`data_mismatch` otherwise), so a blank ISA02 matches `""` and
+            not ten spaces.
           examples:
-            - '          '
+            - ''
         isa03:
           type: string
           enum:
@@ -469,9 +478,12 @@ components:
             - '00'
         isa04:
           type: string
-          description: X12 ISA04 - Security Information (10 characters)
+          description: |-
+            X12 ISA04 — Security Information. When parsing, an inbound file's ISA04 must match this
+            value after trimming (`data_mismatch` otherwise), so a blank ISA04 matches `""` and not
+            ten spaces.
           examples:
-            - '          '
+            - ''
         tpIdQualifier:
           type: string
           description: |
@@ -539,12 +551,16 @@ components:
             - ':'
         tpGroupId:
           type: string
-          description: X12 GS02 - Trading partner's application sender/receiver code
+          description: |-
+            Trading partner's X12 application code: GS02 (sender) on files the partner sends and GS03
+            (receiver) on files you send.
           examples:
             - ACME
         myGroupId:
           type: string
-          description: X12 GS03 - Your application sender/receiver code
+          description: |-
+            Your X12 application code: GS03 (receiver) on files the partner sends and GS02 (sender) on
+            files you send.
           examples:
             - MYAPP
         gs07:

package/dist/editransaction.yml

@@ -209,9 +209,6 @@ paths:
                         fileType: X12
                         documentType: '850'
                         documentNumber: PO03302026A
-                        referenceDocumentNumber:
-                          - PO PO03302026A
-                        lifecycleStatus: PO received
                         direction: Inbound
                         faStatus: inProgress
                         sandbox: false

package/dist/enduser.yml

@@ -1936,21 +1936,11 @@ components:
           format: objectId
           x-celigo-refModel: connectors
           readOnly: true
-          description: |
-            Reference to the integration app that defines this resource.
-
-            This field is only populated for resources that are part of an integration app.
-            It contains the unique identifier (_id) of the integration app (connector)
-            that defines the structure, behavior, and templates for this resource.
-
-            The integration app is the published template that can be installed
-            multiple times across different accounts, with each installation creating
-            a separate integration instance (referenced by _integrationId).
-
-            This reference enables:
-            - Identifying the source integration app for this resource
-            - Determining which template version is being used
-            - Linking to documentation, support, and marketplace information
+          description: |-
+            Integration App (connector) that defines this resource. Present only on resources an
+            Integration App owns. The app locks parts of these documents, and a PUT that changes a
+            locked field answers 200 but keeps the stored value, so read the document back to confirm
+            a change.
           examples:
             - 5e8d43a1b9e5a80011a35f1b
           x-celigo-ai-guidance:

package/dist/export.yml

@@ -16385,8 +16385,10 @@ components:
           description: |-
             EDI profile this export uses to parse incoming X12 or EDIFACT documents into structured
             JSON — it supplies the envelope qualifiers, delimiters, version, and validation rules.
-            Set it when the export parses or validates EDI files; omit it otherwise. Accepted on the
-            file-reading exports — FTP, AS2, S3 and HTTP file mode (`http.type: "file"`).
+            Set it when the export parses or validates EDI files (a save with a `delimited/x12` file
+            definition at `version` `"2"` and no profile fails with 422 `missing_ediProfile`); omit
+            it otherwise. Accepted on the file-reading exports — FTP, AS2, S3 and HTTP file mode
+            (`http.type: "file"`).
           x-celigo-ai-guidance:
             - 'An HTTP export accepts this field only in file mode (`http.type: "file"`, the folder mode of file-provider connectors such as Google Drive, Box, Dropbox, Azure Blob, Google Cloud Storage and Celigo Storage). On a REST/records HTTP export the save is rejected with `not_supported`: "EDIProfile can only be associated with the export of type FTP, AS2, S3 or HTTP file."'
           examples:
@@ -16571,21 +16573,11 @@ components:
           format: objectId
           x-celigo-refModel: connectors
           readOnly: true
-          description: |
-            Reference to the integration app that defines this resource.
-
-            This field is only populated for resources that are part of an integration app.
-            It contains the unique identifier (_id) of the integration app (connector)
-            that defines the structure, behavior, and templates for this resource.
-
-            The integration app is the published template that can be installed
-            multiple times across different accounts, with each installation creating
-            a separate integration instance (referenced by _integrationId).
-
-            This reference enables:
-            - Identifying the source integration app for this resource
-            - Determining which template version is being used
-            - Linking to documentation, support, and marketplace information
+          description: |-
+            Integration App (connector) that defines this resource. Present only on resources an
+            Integration App owns. The app locks parts of these documents, and a PUT that changes a
+            locked field answers 200 but keeps the stored value, so read the document back to confirm
+            a change.
           examples:
             - 5e8d43a1b9e5a80011a35f1b
           x-celigo-ai-guidance:

package/dist/filedefinition.yml

@@ -460,9 +460,9 @@ components:
         - **Delimited (CSV / TSV)** — one element per column.  `name` is
           the human label; `value` is the column id used to address the
           field downstream (e.g. `orderId`, `customerName`).
-        - **Fixed-width** — adds `startPosition` + `length` (or the
-          legacy `start` / `end` pair) to describe the column's offset
-          within each row.
+        - **Fixed-width** — one element per column, gaps included, each
+          with a `length`.  Columns are read in element order;
+          `startPosition` doesn't move a column.
         - **EDI X12 / EDIFACT** — element values follow the segmentNN
           convention (`ISA01`, `BEG03`, `UNB02`).  Segment-element
           definitions whose value comes from the trading-partner profile
@@ -489,7 +489,9 @@ components:
             descriptive text such as `Authorization Information
             Qualifier`; for delimited data columns, the output key (the
             parser uses `name` as the field key in each parsed
-            record); for the row-type marker, equals `value`.
+            record); for the row-type marker, equals `value` (in a
+            container's child rule, a marker whose `name` differs from
+            its `value` parses to an empty record without an error).
           examples:
             - Order ID
             - Authorization Information Qualifier
@@ -657,28 +659,30 @@ components:
           type: integer
           minimum: 1
           description: |
-            Fixed-width: 1-based start column (inclusive).  Pair with
-            `length` to describe the column extent.  Mutually exclusive
-            with the legacy `start` / `end` pair — pick one
-            convention per element.
+            Doesn't place the column: fixed-width columns are read in
+            element order, each `length` characters wide, so a definition
+            that skips columns misreads them without an error.  Describe a
+            gap with a placeholder element of the gap's width instead.
         length:
           type: integer
           minimum: 1
           description: |
-            Fixed-width: column width in characters.  Pair with
-            `startPosition`.
+            Fixed-width: column width in characters.  Every fixed-width
+            element needs one; the parser refuses an element without it
+            (`Every fixed width element must provide a "length" property
+            between 1 and 512.`).
         start:
           type: integer
           description: |
-            Legacy fixed-width start offset (kept for backward
-            compatibility).  Pair with `end`.  Prefer
-            `startPosition` + `length` on new definitions.
+            Legacy fixed-width start offset, paired with `end`.  It doesn't
+            replace `length`: an element with `start`/`end` and no
+            `length` is refused.
         end:
           type: integer
           description: |
-            Legacy fixed-width end offset (kept for backward
-            compatibility).  Pair with `start`.  Prefer
-            `startPosition` + `length` on new definitions.
+            Legacy fixed-width end offset, paired with `start`.  It doesn't
+            replace `length`: an element with `start`/`end` and no
+            `length` is refused.
     CompositeValue:
       type: object
       additionalProperties: true
@@ -735,11 +739,11 @@ components:
         - **Branch rule** — has `children` (and optionally `elements`).
           Used to nest loops / sub-segments.  EDI envelopes always nest
           their inner segments under `children`.
-        - **Container rule** — sets `container: true`.  Acts as a loop
-          wrapper without producing an output row of its own.  When
-          `container` is true, `maxOccurrence` MUST be greater than
-          `1` (the parser rejects `container: true` with `maxOccurrence
-          <= 1`).
+        - **Container rule** — sets `container: true`.  A loop wrapper
+          that produces no row of its own: a group `name`, a
+          `maxOccurrence` above `1` and no `elements`, with the repeated
+          row's rule under `children`.  It is the only shape that repeats
+          rows (see `container`).
 
         **Envelopes and `closeRule`**
 
@@ -782,7 +786,9 @@ components:
             `name` and `value` set to the segment id (e.g.
             `{"name": "ISA", "value": "ISA"}`) followed by one element
             per segment-element (`ISA01`, `ISA02`, ...).  Delimited
-            rules use one element per column.
+            rules use one element per column.  Omit the key on a rule
+            with no elements of its own, such as a container wrapper: an
+            empty `elements` array fails the parse.
           items:
             $ref: '#/components/schemas/Element'
         children:
@@ -822,13 +828,16 @@ components:
           type: boolean
           description: |
             Marks this rule as a pure loop wrapper that does not emit a
-            row of its own.  Used on EDI `ST` / `UNH` containers so
-            the parser knows to iterate the inner transaction body up to
-            `maxOccurrence` times without recording the wrapper itself.
+            row of its own, and is the only way rows repeat: give the
+            wrapper a group `name`, a `maxOccurrence` above `1` and no
+            `elements`, and put the repeated row's rule under its
+            `children` (for EDI, the `ST` or `UNH` rule with its elements,
+            children and `closeRule`).  Parsed rows come back as an array
+            under the wrapper's `name`; `container: true` on a rule with
+            its own `elements` isn't honored as a loop.
 
-            When `container: true` is set, `maxOccurrence` MUST be
-            greater than `1`.  The parser rejects
-            `container: true` paired with `maxOccurrence <= 1` with
+            The parser rejects `container: true` paired with
+            `maxOccurrence <= 1` with
             `Invalid rules: maxOccurences should be greater than '1',
             when the container is 'true'`.
           default: false
@@ -840,10 +849,10 @@ components:
           minimum: 1
           description: |
             Upper bound on how many times this rule may repeat at its
-            current position.  EDI envelopes typically use `1` (one
-            ISA per file, one GS per group), while transaction-set
-            loops (`ST` containers, line-item loops) use larger
-            values such as `1000`.
+            current position.  Rows repeat only under a `container`
+            wrapper, so larger values such as `1000` go on the wrapper of
+            an `ST` transaction set or a line-item loop; EDI envelopes use
+            `1` (one ISA per file, one GS per group).
 
             Required to be greater than `1` when `container` is
             `true`.
@@ -972,14 +981,15 @@ components:
           description: EDI document type for acknowledgement documents.
         globalId:
           type: string
-          description: |
-            Global identifier mapping to a known EDI standard document definition.
-
-            Required for EDI formats (`delimited/x12` or `delimited/edifact`) when the
-            account has an EDI license enabled. Must reference a valid entry in the
-            standard file definitions metadata. Immutable after creation.
+          description: |-
+            Entry in the platform's registry of standard EDI document definitions that this
+            definition is built from. On an EDI-licensed account an X12 or EDIFACT create without
+            it fails with 422 `global_id_not_provided`, and one naming an id the registry doesn't
+            have fails with 422 `invalid_global_id`. No public route lists the registry, so copy the
+            `globalId` of an existing definition for the same standard document. Immutable after
+            creation.
           examples:
-            - 3c7a8f2e-1234-5678-9abc-def012345678
+            - Generic-4010-850-PurchaseOrder
         rules:
           type: array
           x-celigo-agent:
@@ -991,12 +1001,14 @@ components:
             `format` (delimited, EDI X12/EDIFACT, and fixed-width): the first
             element is the file's root rule, EDI envelopes nest through
             `Rule.children`, and openers pair with trailers via
-            `Rule.closeRule`. Fixed-width rules carry the column offsets on
-            each element (`startPosition`/`length`).
+            `Rule.closeRule`. Fixed-width rules list every column in order,
+            each element with its `length`.
 
             The cleared / "no rules configured" form is an empty array `[]`.
             The serialized rules tree must not exceed 20 KB once attached to
-            the parent file definition document.
+            the parent file definition document. A save doesn't parse a sample,
+            so a tree that saves can still fail or drop rows when parsed; test
+            it against a sample with `POST /v1/processors/structuredFileParser`.
           items:
             $ref: '#/components/schemas/Rule'
         fixed:
@@ -1101,43 +1113,14 @@ components:
             - ext-filedef-12345
       x-celigo-ai-guidance:
         - |-
-          Delimited / EDI shape: an ordered list of root ``Rule`` nodes.
-          For non-EDI delimited files this is typically a single-element
-          array carrying one rule whose ``elements`` describe the
-          columns.  For EDI (X12 / EDIFACT) the array still has one root
-          rule, but that rule's ``children`` build the
-          envelope → group → transaction → segment hierarchy.
+          `rules` is an ordered array of `Rule` nodes for every `format`, fixed-width included. For
+          EDI (X12 / EDIFACT) the root rule's `children` build the envelope → group → transaction →
+          segment hierarchy.
         - |-
-          The rules tree describes how the structuredFileParser walks a file
-          row-by-row (delimited / EDI) or by fixed offsets (fixed-width) and
-          extracts named fields and nested loops/segments.
-
-          ## SHAPE — VARIES BY ``format``
-
-          Two valid top-level shapes, selected by the parent file definition's
-          ``format``:
-
-          - **Array of ``Rule``** — used by every delimited variant
-            (``delimited``, ``delimited/x12``, ``delimited/edifact``, etc.).
-            The first element is the file's root rule; for EDI, deeper
-            envelopes nest through ``Rule.children``.
-
-          - **Single ``Rule`` object** — used by ``format: "fixed"`` (fixed-
-            width).  The whole file is described by one rule whose
-            ``elements`` enumerate the columns by ``startPosition`` /
-            ``length``.
-
-          The ``oneOf`` below documents both shapes.  Tooling that consumes
-          this spec to drive UI rendering or generation should branch on
-          ``format`` to decide which arm applies — there is no
-          discriminator field on the rules tree itself.
-
-          ## EMPTY / CLEARED FORM
-
-          A cleared rules tree is ``[]`` for delimited / EDI and ``{}`` for
-          fixed-width.  Both empty forms are accepted by the parser as
-          "no rules configured" and round-trip cleanly through the
-          structuredFileParser.
+          Rows repeat only under an elements-less `container: true` rule (a group `name`,
+          `maxOccurrence` above 1, no `elements`) whose child rule carries the row's elements. A
+          row-marker rule with no such container above it matches only the first row, and the parser
+          drops the rest without an error.
     ResourceResponse:
       type: object
       description: Response

package/dist/guardrail.yml

@@ -516,21 +516,11 @@ components:
           format: objectId
           x-celigo-refModel: connectors
           readOnly: true
-          description: |
-            Reference to the integration app that defines this resource.
-
-            This field is only populated for resources that are part of an integration app.
-            It contains the unique identifier (_id) of the integration app (connector)
-            that defines the structure, behavior, and templates for this resource.
-
-            The integration app is the published template that can be installed
-            multiple times across different accounts, with each installation creating
-            a separate integration instance (referenced by _integrationId).
-
-            This reference enables:
-            - Identifying the source integration app for this resource
-            - Determining which template version is being used
-            - Linking to documentation, support, and marketplace information
+          description: |-
+            Integration App (connector) that defines this resource. Present only on resources an
+            Integration App owns. The app locks parts of these documents, and a PUT that changes a
+            locked field answers 200 but keeps the stored value, so read the document back to confirm
+            a change.
           examples:
             - 5e8d43a1b9e5a80011a35f1b
           x-celigo-ai-guidance:

package/dist/iclient.yml

@@ -4317,21 +4317,11 @@ components:
           format: objectId
           x-celigo-refModel: connectors
           readOnly: true
-          description: |
-            Reference to the integration app that defines this resource.
-
-            This field is only populated for resources that are part of an integration app.
-            It contains the unique identifier (_id) of the integration app (connector)
-            that defines the structure, behavior, and templates for this resource.
-
-            The integration app is the published template that can be installed
-            multiple times across different accounts, with each installation creating
-            a separate integration instance (referenced by _integrationId).
-
-            This reference enables:
-            - Identifying the source integration app for this resource
-            - Determining which template version is being used
-            - Linking to documentation, support, and marketplace information
+          description: |-
+            Integration App (connector) that defines this resource. Present only on resources an
+            Integration App owns. The app locks parts of these documents, and a PUT that changes a
+            locked field answers 200 but keeps the stored value, so read the document back to confirm
+            a change.
           examples:
             - 5e8d43a1b9e5a80011a35f1b
           x-celigo-ai-guidance:

package/dist/import.yml

@@ -16774,21 +16774,11 @@ components:
           format: objectId
           x-celigo-refModel: connectors
           readOnly: true
-          description: |
-            Reference to the integration app that defines this resource.
-
-            This field is only populated for resources that are part of an integration app.
-            It contains the unique identifier (_id) of the integration app (connector)
-            that defines the structure, behavior, and templates for this resource.
-
-            The integration app is the published template that can be installed
-            multiple times across different accounts, with each installation creating
-            a separate integration instance (referenced by _integrationId).
-
-            This reference enables:
-            - Identifying the source integration app for this resource
-            - Determining which template version is being used
-            - Linking to documentation, support, and marketplace information
+          description: |-
+            Integration App (connector) that defines this resource. Present only on resources an
+            Integration App owns. The app locks parts of these documents, and a PUT that changes a
+            locked field answers 200 but keeps the stored value, so read the document back to confirm
+            a change.
           examples:
             - 5e8d43a1b9e5a80011a35f1b
           x-celigo-ai-guidance:

package/dist/integration.yml

@@ -29,9 +29,10 @@ tags:
         `install`, `installSteps`) also appear on a standard integration created by the
         UI's clone-and-install, so they do not by themselves mean Integration App.
 
-      Integrations support **Integration Lifecycle Management (ILM)**: clone an integration
-      across environments, then use revisions (snapshot, pull, revert) to promote changes
-      between them. Lifecycle operations carry every resource the integration contains.
+      Integrations support **Integration Lifecycle Management (ILM)**: revisions (snapshot,
+      pull, revert) promote changes between an integration and its lifecycle-linked clones,
+      and carry every resource the integration contains. Only the UI's clone-and-install
+      links a clone; `POST /v1/integrations/{_id}/clone` makes a standalone copy.
 
       ## Integration schema
 
@@ -339,7 +340,8 @@ paths:
         - Integrations
       description: |-
         Deletes an integration. The integration is soft-deleted and retained in the
-        recycle bin for 30 days before permanent removal.
+        recycle bin for 30 days before permanent removal. Delete the APIs and Tools it
+        contains, and remove its aliases that point at lookup caches, first.
       parameters:
         - name: _id
           in: path
@@ -359,14 +361,28 @@ paths:
         '404':
           $ref: '#/components/responses/404-not-found'
         '422':
-          $ref: '#/components/responses/422-dependency-conflict'
+          description: |-
+            The integration still contains resources that must be deleted first, APIs and Tools
+            among them (`dependencies_not_deleted`, one entry per blocking resource), or one of its
+            `aliases[]` still points at a lookup cache.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+              examples:
+                lookup_cache_alias:
+                  value:
+                    errors:
+                      - message: integration 6842261335b64c0bcb308e4f owns alias "customeridcache" pointing to lookupcache 68680d7111d1437fbcbce534. Alias must be deleted before this resource can be deleted.
   /v1/integrations/{_id}/clone:
     post:
       x-internal: false
       summary: Clone an integration
       description: |
-        Creates a copy of an existing integration. When the source has registered
-        connections, remap each one via `connectionMap`; mapped connections are reused, not cloned.
+        Creates a standalone copy of an existing integration: the copy records its source in
+        `_sourceId` but isn't lifecycle-linked to it, so a pull between the two finds no changes.
+        When the source has registered connections, remap each one via `connectionMap`; mapped
+        connections are reused, not cloned.
       operationId: cloneIntegration
       tags:
         - Integrations
@@ -416,6 +432,28 @@ paths:
           $ref: '#/components/responses/401-unauthorized'
         '404':
           $ref: '#/components/responses/404-not-found'
+        '422':
+          description: |-
+            A `connectionMap` key is missing or isn't one of the source's registered connections, or a
+            value isn't a connection in the target environment (`invalid_connectionId`). Nothing is
+            created.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+              examples:
+                missing_key:
+                  summary: A registered connection is missing from connectionMap
+                  value:
+                    errors:
+                      - code: invalid_connectionId
+                        message: 'The _connectionId provided for the key ''6553ebdeda62bb22e7fa81ff'': '''' is invalid.'
+                unknown_key:
+                  summary: A key that isn't one of the source's registered connections
+                  value:
+                    errors:
+                      - code: invalid_connectionId
+                        message: The key '64a1234567890abcdef12399' in connectionMap doesn't match with any of the _id's of the connection documents.
   /v1/integrations/{_id}/clone/preview:
     get:
       x-internal: false
@@ -678,7 +716,7 @@ paths:
       operationId: getIntegrationRevisionDiff
       tags:
         - Integrations
-      summary: Diff a pending revision
+      summary: Diff a pull or revert revision
       description: |-
         Returns the before/after diff for a pull or revert revision. The diff is materialized on `pull`
         and `revert` revisions and is retained on their `completed` state -- available for both
@@ -710,7 +748,7 @@ paths:
               - 6a28d2af6d42eb08f8e863e7
       responses:
         '200':
-          description: Diff envelope for the pending revision.
+          description: Diff envelope for the revision.
           content:
             application/json:
               schema:
@@ -1815,8 +1853,12 @@ paths:
         cache does not already have one: `alias` is a slug of the cache name
         (lowercased, whitespace and special characters stripped, `_2`/`_3`/…
         appended on collision) and `_lookupCacheId` points at the cache. Scripts
-        and hooks use the alias as a stable handle for the cache, and
-        deregistering the cache is blocked until the alias is removed.
+        and hooks use the alias as a stable handle for the cache, and the
+        `{{getLookupCacheData}}` Handlebars helper reads the cache only through
+        it: the alias is matched case-sensitively, and a cache `_id` in its place
+        fails with `alias "…" not found in integration/flow aliases.`.
+        Deregistering or deleting the cache, and deleting the integration, are
+        blocked until the alias is removed.
       parameters:
         - name: _id
           in: path
@@ -1932,7 +1974,10 @@ paths:
         of the cache name (lowercased, whitespace and special characters stripped,
         `_2`/`_3`/… appended on collision) and `_lookupCacheId` points at the
         cache. Scripts and hooks use the alias as a stable handle for the cache,
-        and deregistering the cache is blocked until the alias is removed.
+        and the `{{getLookupCacheData}}` Handlebars helper reads the cache only
+        through it (matched case-sensitively; a cache `_id` is not accepted).
+        Deregistering or deleting the cache, and deleting the integration, are
+        blocked until the alias is removed.
       parameters:
         - name: _id
           in: path
@@ -3524,7 +3569,12 @@ components:
           examples:
             - install
         settings:
-          description: Integration App settings object for this integration.
+          description: |-
+            Integration App settings object for this integration. An Integration App can also keep
+            its settings fields here, each with its current value: `settings.general` and
+            `settings.sections[]` (tabs, then nested `sections[]`, then `fields[]`; a flow entry's own
+            fields sit in its `settings[]`). When `settings.supportsMultiStore` is true, each
+            `settings.sections[]` entry is a store and its own `sections[]` are the tabs.
           allOf:
             - description: |-
                 Integration App settings object for this integration.
@@ -4212,12 +4262,12 @@ components:
         _sourceId:
           type: string
           format: objectId
+          x-celigo-refModel: integrations
           examples:
             - 6842261335b64c0bcb308e4f
           description: |-
-            System-assigned source identifier for the integration.
-
-            Typically system-managed; omit in normal create/update payloads.
+            Integration this one was cloned from. Set on every clone, standalone copies included, so
+            it doesn't by itself mean the two are lifecycle-linked. Omit in create and update payloads.
         sampleIntegration:
           type: boolean
           description: |-
@@ -4521,8 +4571,11 @@ components:
             Keys are source connection _ids on the original integration; values
             are target connection _ids in the destination environment.
             Required when the source integration has registered connections — omitting it or
-            sending an empty map fails with 400 `invalid_connectionMap`. Map a connection to
-            itself to reuse it in the clone; omit the map when the source has none.
+            sending an empty map fails with 400 `invalid_connectionMap`. Every registered
+            connection must be a key, mapped to a connection in the target environment: a missing or
+            unknown key, or a value that isn't a connection there, fails with 422
+            `invalid_connectionId`. Map a connection to itself to reuse it in the clone; omit the map
+            when the source has none.
           additionalProperties:
             type: string
           example:
@@ -4760,13 +4813,13 @@ components:
     RevisionDiffResponse:
       type: object
       description: |-
-        Structured before/after diff for a revision. Only available while the revision is in a `pending`
-        state (e.g. a queued `pull` or `revert`). Completed snapshot revisions are read-only and return
-        HTTP 400 `invalid_revision_state` — the diff is computed during the apply window, not retained.
+        Structured before/after diff for a `pull` or `revert` revision, available on an `inprogress`
+        one once its install steps have materialized and kept once it is `completed`. Snapshot,
+        `canceled` and `failed` revisions have none and return HTTP 400 `invalid_revision_state`.
 
-        Shape is the platform's internal diff document — a map of resource type → per-resource
-        before/after blocks. Treated as an opaque envelope here; specific field layout is not guaranteed
-        stable across platform versions.
+        A `{before, after}` envelope: each side maps resource type to resource id to that resource's
+        snapshot. Treated as an opaque envelope here; specific field layout is not guaranteed stable
+        across platform versions.
       additionalProperties: true
     RevisionError:
       type: object
@@ -5457,19 +5510,5 @@ components:
                 errors:
                   - code: not_found
                     message: The requested resource was not found.
-    422-dependency-conflict:
-      description: |-
-        The resource has dependents that must be deleted first. Each entry
-        in the `errors` array names one blocking resource.
-      content:
-        application/json:
-          schema:
-            $ref: '#/components/schemas/Error'
-          examples:
-            default:
-              value:
-                errors:
-                  - code: dependencies_not_deleted
-                    message: export 6902d88c10b42b2eaac9b2a1 must be deleted before you can delete connection 6398ddf316be761fb16a6523
 x-enable-proxy: true
 x-internal: false

package/dist/lookupcache.yml

@@ -10,7 +10,9 @@ info:
       and cross-reference resolution.
 
       Each lookup cache:
-      - Belongs to a specific integration
+      - Is account-level: an integration uses it once registered there
+        (`PUT /v1/integrations/{_id}/lookupcaches/register`), which also adds an alias to the
+        integration's `aliases[]`
       - Has a maximum size of 50 MB per cache
       - Is subject to a per-environment aggregate limit of 1 GB
       - Can optionally include its data when used in templates and cloning
@@ -119,8 +121,8 @@ paths:
       x-internal: false
       summary: Create a lookup cache
       description: |-
-        Creates a new empty lookup cache. Only `name` is required. Populate
-        it afterwards via `POST /v1/lookupcaches/{_id}/data`.
+        Creates a new empty lookup cache. Populate it afterwards via
+        `POST /v1/lookupcaches/{_id}/data`.
       operationId: createLookupCache
       tags:
         - Lookup Caches
@@ -354,6 +356,19 @@ paths:
           $ref: '#/components/responses/401-unauthorized'
         '404':
           $ref: '#/components/responses/404-not-found'
+        '422':
+          description: |-
+            An integration's `aliases[]` still points at the cache. Registering a cache adds such an
+            alias, so remove it from that integration's `aliases`, then delete again.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+              examples:
+                alias_referenced:
+                  value:
+                    errors:
+                      - message: lookupcache 69c2eb25365fb658aa39c642 is referenced by an alias on integration 6842261335b64c0bcb308e4f. Alias must be deleted before resource can be deleted.
   /v1/lookupcaches/{_id}/clone/preview:
     get:
       x-internal: false
@@ -418,8 +433,9 @@ paths:
         read-then-write per key. Values may be null, numbers, booleans,
         strings, or objects — arrays at the top level are rejected (wrap them in an
         object). One invalid entry fails the entire batch and nothing in it is written:
-        a bad value returns `400 invalid_value`, and an empty, missing, or over-length
-        key returns `400 cache_dynamodb_invalid_key`.
+        a bad value returns `400 invalid_value`, an empty, missing, or over-length
+        key returns `400 cache_dynamodb_invalid_key`, and a key that appears twice in
+        the batch returns 400 "Duplicate keys found in the request".
 
         The service rejects batches larger than ~1000 entries or ~5 MB of JSON.
         Callers uploading more than that should split their payload; the Celigo CLI

package/dist/marketplace.yml

@@ -238,8 +238,8 @@ paths:
           description: |-
             No template matched the id. Most commonly: the id belongs to a
             Connector (Integration App) rather than a Template — Connectors are
-            installed via `/v1/integrations/<id>/install`, not through this
-            preview endpoint.
+            installed via `POST /v1/connectors/{_id}/install`, available only to
+            Celigo Partners, not through this preview endpoint.
           content:
             application/json:
               schema:

package/dist/mcp-server.yml

@@ -3761,21 +3761,11 @@ components:
           format: objectId
           x-celigo-refModel: connectors
           readOnly: true
-          description: |
-            Reference to the integration app that defines this resource.
-
-            This field is only populated for resources that are part of an integration app.
-            It contains the unique identifier (_id) of the integration app (connector)
-            that defines the structure, behavior, and templates for this resource.
-
-            The integration app is the published template that can be installed
-            multiple times across different accounts, with each installation creating
-            a separate integration instance (referenced by _integrationId).
-
-            This reference enables:
-            - Identifying the source integration app for this resource
-            - Determining which template version is being used
-            - Linking to documentation, support, and marketplace information
+          description: |-
+            Integration App (connector) that defines this resource. Present only on resources an
+            Integration App owns. The app locks parts of these documents, and a PUT that changes a
+            locked field answers 200 but keeps the stored value, so read the document back to confirm
+            a change.
           examples:
             - 5e8d43a1b9e5a80011a35f1b
           x-celigo-ai-guidance:

package/dist/recyclebin.yml

@@ -416,7 +416,10 @@ paths:
       description: |-
         Permanently purges a resource from the recycle bin. This action
         cannot be undone — the resource data is irrecoverably removed.
-        Resources are auto-purged after 30 days.
+        Resources are auto-purged after 30 days. A purge removes only the
+        named resource: purge the bin entries that still reference it first
+        (a deleted flow references its integration and the exports and imports
+        it used).
       parameters:
         - $ref: '#/components/parameters/ResourceType'
         - name: _id
@@ -449,6 +452,17 @@ paths:
                     message: Recycle Bin operations are not supported for the given model at this time
         '404':
           $ref: '#/components/responses/404-not-found'
+        '422':
+          description: |-
+            Another recycle-bin entry still references the resource. Purge that
+            entry first, then retry.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+              example:
+                errors:
+                  - message: 'this document is referenced by Flow : 60a2c4e6f321d800129a1a3c'
   /v1/recycleBinTTL/{resourceType}/{_id}/doCascadeRestore:
     post:
       x-internal: false

package/dist/template.yml

@@ -329,6 +329,11 @@ paths:
         whose `type` is `mcpserver` is rejected before anything is created —
         install it with `POST /v1/mcpservers/template/{_templateId}` instead.
         Check `type` on the `GET /v1/templates/{_id}/preview` response first.
+
+        This one-shot install doesn't run a template's own install steps. A
+        template whose preview `Integration` object lists `installSteps` is
+        refused with nothing created; install it from the integrator.io
+        marketplace, whose installer runs those steps.
       parameters:
         - name: _id
           in: path
@@ -371,19 +376,36 @@ paths:
                     61f92026dd053843b5d72350: 64a1234567890abcdef12345
                     61f92026dd053843b5d72351: 64a1234567890abcdef12346
       responses:
-        '200':
-          description: Template installed successfully.
+        '201':
+          description: Template installed. Returns one entry per resource the install created.
           content:
             application/json:
               schema:
-                type: object
-                description: The created integration and related resources.
-                additionalProperties: true
+                type: array
+                description: The resources the install created, the new integration among them.
+                items:
+                  type: object
+                  properties:
+                    model:
+                      type: string
+                      description: Resource type of the created document (`Integration`, `Flow`, `Export`, `Import`, ...).
+                    _id:
+                      type: string
+                      format: objectId
+                      description: Id of the created document.
+                  additionalProperties: true
               examples:
                 installed:
-                  summary: Integration created from the template
+                  summary: Integration, flow, export and import created from the template
                   value:
-                    _integrationId: 6405b9d73496e05ff253d587
+                    - model: Integration
+                      _id: 6405b9d73496e05ff253d587
+                    - model: Flow
+                      _id: 6405b9d83496e05ff253d58c
+                    - model: Export
+                      _id: 6405b9d83496e05ff253d590
+                    - model: Import
+                      _id: 6405b9d83496e05ff253d594
         '400':
           description: |-
             Missing or empty `connectionMap`, or the template is an MCP server
@@ -424,7 +446,8 @@ paths:
         '422':
           description: |-
             Connection IDs in `connectionMap` do not match the template's
-            expected connection IDs.
+            expected connection IDs, or the template has its own install steps
+            (a `template_zip` step this install doesn't run). Nothing is created.
           content:
             application/json:
               schema:
@@ -435,6 +458,11 @@ paths:
                     errors:
                       - code: invalid_connectionId
                         message: Invalid connection ID in connectionMap.
+                templateInstallSteps:
+                  summary: Template with its own install steps
+                  value:
+                    errors:
+                      - message: 'Failed to create Integration due to: Install step is invalid: invalid templateZip.'
   /v1/integrations/template/preview:
     get:
       x-internal: false

package/dist/tool.yml

@@ -7146,21 +7146,11 @@ components:
           format: objectId
           x-celigo-refModel: connectors
           readOnly: true
-          description: |
-            Reference to the integration app that defines this resource.
-
-            This field is only populated for resources that are part of an integration app.
-            It contains the unique identifier (_id) of the integration app (connector)
-            that defines the structure, behavior, and templates for this resource.
-
-            The integration app is the published template that can be installed
-            multiple times across different accounts, with each installation creating
-            a separate integration instance (referenced by _integrationId).
-
-            This reference enables:
-            - Identifying the source integration app for this resource
-            - Determining which template version is being used
-            - Linking to documentation, support, and marketplace information
+          description: |-
+            Integration App (connector) that defines this resource. Present only on resources an
+            Integration App owns. The app locks parts of these documents, and a PUT that changes a
+            locked field answers 200 but keeps the stored value, so read the document back to confirm
+            a change.
           examples:
             - 5e8d43a1b9e5a80011a35f1b
           x-celigo-ai-guidance:
@@ -37376,8 +37366,10 @@ components:
           description: |-
             EDI profile this export uses to parse incoming X12 or EDIFACT documents into structured
             JSON — it supplies the envelope qualifiers, delimiters, version, and validation rules.
-            Set it when the export parses or validates EDI files; omit it otherwise. Accepted on the
-            file-reading exports — FTP, AS2, S3 and HTTP file mode (`http.type: "file"`).
+            Set it when the export parses or validates EDI files (a save with a `delimited/x12` file
+            definition at `version` `"2"` and no profile fails with 422 `missing_ediProfile`); omit
+            it otherwise. Accepted on the file-reading exports — FTP, AS2, S3 and HTTP file mode
+            (`http.type: "file"`).
           x-celigo-ai-guidance:
             - 'An HTTP export accepts this field only in file mode (`http.type: "file"`, the folder mode of file-provider connectors such as Google Drive, Box, Dropbox, Azure Blob, Google Cloud Storage and Celigo Storage). On a REST/records HTTP export the save is rejected with `not_supported`: "EDIProfile can only be associated with the export of type FTP, AS2, S3 or HTTP file."'
           examples:

package/dist/tradingpartnerconnector.yml

@@ -899,7 +899,8 @@ components:
         - |-
           A field that is automatically set to a predefined value during trading partner onboarding.
           The `path` identifies which field on the target resource to set,
-          and `values` provides the value(s) to assign.
+          and `values` provides the value(s) to assign, except the template stand-ins named on the
+          section's `preConfiguredFields` and `supportedBy.connection.preConfiguredFields`.
       properties:
         _id:
           type: string
@@ -954,9 +955,15 @@ components:
             - 6a2a623c715132b80ae5d06c
         path:
           type: string
-          description: Dot-notation path of the field on the target resource.
+          description: |-
+            Dot-notation path of the field on the target resource, or the field's form label: EDI
+            profile sections commonly name fields by label (for example the trading partner
+            interchange ID), so map a label to its profile field before checking it.
           x-celigo-ai-guidance:
-            - Dot-notation path of the field on the target resource that the user must set.
+            - |-
+              The field the user must set, as a dot-notation path on the target resource or as the
+              field's form label (common in EDI profile sections). Map a label to its profile field,
+              such as the trading partner interchange ID to `tpInterchangeId`, before checking it.
           examples:
             - name
             - ftp.username
@@ -1042,12 +1049,17 @@ components:
                 $ref: '#/components/schemas/Filter'
         preConfiguredFields:
           type: array
-          description: Fields automatically set during onboarding. Not editable by the user.
+          description: |-
+            Fields set to predefined values during onboarding. In an EDI profile section, a value for
+            your own identity (`myInterchangeId`, `myGroupId`) or a placeholder partner ID such as
+            `XXXXXXXXXXXXXXX` is a template stand-in, not a real value; the real IDs are among the
+            fields the user must set.
           x-celigo-ai-guidance:
             - |-
-              Array of fields that are automatically set to predefined values when creating a
-              trading partner resource using this connector.
-              These fields are not editable by the user during onboarding.
+              Fields set to predefined values when a trading partner resource is created from this
+              connector. In an EDI profile section, never apply an own-identity value
+              (`myInterchangeId`, `myGroupId`) or a placeholder partner ID such as `XXXXXXXXXXXXXXX`:
+              they are template stand-ins, and the real IDs come from the user and the partner.
           items:
             $ref: '#/components/schemas/PreConfiguredField'
         fieldsUserMustSet:
@@ -1165,7 +1177,11 @@ components:
                 $ref: '#/components/schemas/Filter'
         preConfiguredFields:
           type: array
-          description: Fields automatically set on the connection during onboarding.
+          description: |-
+            Fields automatically set on the connection during onboarding. Apart from the transport
+            `type`, treat them as template stand-ins (published connectors carry values such as a
+            placeholder AS2 partner ID and a staging AS2 URI), not the partner's real settings; the
+            partner's host and identity are in `fieldsUserMustSet`.
           items:
             $ref: '#/components/schemas/PreConfiguredField'
         fieldsUserMustSet:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@celigo/api-specs",
-  "version": "0.2.136",
+  "version": "0.2.138",
   "private": false,
   "description": "Public OpenAPI bundles (dist/) and the celigo-cli lint schema pack (schemas.json).",
   "keywords": [

package/schemas.json

@@ -1,7 +1,7 @@
 {
 	"provenance": {
 		"repo": "celigo/integrator-api-specs",
-		"iasCommit": "fde18924",
+		"iasCommit": "8f5ee6ba",
 		"generatedAt": "2026-10-21"
 	},
 	"roots": {