@celigo/api-specs 0.2.137 → 0.2.139

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/processor.yml

@@ -23,7 +23,8 @@ tags:
 
       These are one-shot transformation calls — they do not create or modify
       any resources. Use them to test parsing rules, preview file definitions,
-      or transform data outside of a flow.
+      or transform data outside of a flow. The filter and Handlebars processors
+      test a step's filter rules or templates the same way.
 
       ## Processor descriptor schema
 
@@ -1047,6 +1048,212 @@ paths:
                           type: string
                   path:
                     type: string
+  /v1/processors/filter:
+    post:
+      x-internal: false
+      operationId: evaluateFilterRules
+      tags:
+        - Parsers & Generators
+      summary: Test filter rules against records
+      description: |-
+        Evaluates export and import filter rules (`Filter.expression`) against the records in `data` and
+        returns the records that pass. Nothing is saved and no flow runs, so it checks a rule before the
+        rule is saved on a step. Rules are validated as they are when a filter is saved: an unknown
+        operator or a bare `extract` is refused with 422.
+
+        Send each record bare, the way it reaches a step's filter. A record wrapped as
+        `{"record": {...}}` is evaluated as that wrapper, so field rules don't match it.
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              required:
+                - rules
+                - data
+              properties:
+                rules:
+                  type: object
+                  description: The filter expression to evaluate, in the shape of a step's `filter.expression`.
+                  required:
+                    - version
+                    - rules
+                  properties:
+                    version:
+                      type: string
+                      enum:
+                        - '1'
+                      x-enumDescriptions:
+                        '1': Version 1 of the Celigo expression-based filter format.
+                      description: Version of the filter format used by `rules`.
+                    rules:
+                      type: array
+                      description: Prefix-notation rule in the grammar of `Filter.expression.rules`.
+                      x-celigo-agent:
+                        - filter
+                      items: {}
+                data:
+                  type: array
+                  description: Records to evaluate, each a bare record object.
+                  items:
+                    type: object
+                    additionalProperties: true
+            examples:
+              default:
+                summary: Keep the records whose email has a value
+                value:
+                  rules:
+                    version: '1'
+                    rules:
+                      - notempty
+                      - - string
+                        - - extract
+                          - email
+                  data:
+                    - email: a@example.com
+                    - email: ''
+                    - {}
+      responses:
+        '200':
+          description: The records that pass the rules.
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  mediaType:
+                    type: string
+                    description: Always `json` for the filter processor.
+                    enum:
+                      - json
+                    x-enumDescriptions:
+                      json: Response data is formatted as JSON.
+                  data:
+                    type: array
+                    description: The input records that pass the rules, unchanged and in input order.
+                    items:
+                      type: object
+                      additionalProperties: true
+                  duration:
+                    type: integer
+                    description: Processing time in milliseconds.
+              examples:
+                default:
+                  value:
+                    mediaType: json
+                    data:
+                      - email: a@example.com
+                    duration: 0
+        '401':
+          $ref: '#/components/responses/401-unauthorized'
+        '422':
+          description: |-
+            The rules are invalid, for example an unknown operator ("Invalid operation: isnotempty.") or
+            an `extract` that is not wrapped in a type conversion ("Field operation extract must be called
+            by a Type Conversion Operation but was called by notempty.").
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+  /v1/processors/handlebars:
+    post:
+      x-internal: false
+      operationId: renderHandlebarsTemplate
+      tags:
+        - Parsers & Generators
+      summary: Render a Handlebars template
+      description: |-
+        Renders a Handlebars template against the object in `data` and returns the result. Nothing is
+        saved and no flow runs, so it tests a template or a helper before the template is saved on a
+        step.
+
+        `data` is the template's root context: `{{name}}` reads `data.name`. A template written for a
+        step reads the record as `{{record.<field>}}`, so send the record under `record`
+        (`"data": {"record": {...}}`). Double braces HTML-escape the value (`&` renders as `&amp;`);
+        triple braces insert it unchanged. A `timestamp` with no time zone renders in UTC.
+
+        An unknown helper is refused with 422. `GET /v1/processors` lists helpers under the handlebars
+        entry's `helperFunctions`, but that list is not complete: `eq` and `truncateWords`, for
+        example, render although it omits them, so render a doubtful helper once here before relying
+        on it.
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              required:
+                - rules
+                - data
+              properties:
+                rules:
+                  type: object
+                  required:
+                    - template
+                  properties:
+                    template:
+                      type: string
+                      description: The Handlebars template to render.
+                      x-celigo-agent:
+                        - handlebars
+                    resultMode:
+                      type: string
+                      description: Form of the result; `text` returns the rendered string.
+                      examples:
+                        - text
+                data:
+                  type: object
+                  additionalProperties: true
+                  description: Root context the template renders against.
+            examples:
+              step_template:
+                summary: Render a step template against a record
+                value:
+                  rules:
+                    template: '{{record.name}} | {{{record.name}}}'
+                    resultMode: text
+                  data:
+                    record:
+                      name: Smith & Sons
+      responses:
+        '200':
+          description: The rendered template.
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  mediaType:
+                    type: string
+                    description: Always `text` for the handlebars processor.
+                    enum:
+                      - text
+                    x-enumDescriptions:
+                      text: Response data is the rendered text.
+                  data:
+                    description: |-
+                      The rendered result, normally a string. A template that renders only a helper's
+                      numeric result can come back as a JSON number.
+                  duration:
+                    type: integer
+                    description: Processing time in milliseconds.
+              examples:
+                default:
+                  value:
+                    mediaType: text
+                    data: Smith &amp; Sons | Smith & Sons
+                    duration: 0
+        '401':
+          $ref: '#/components/responses/401-unauthorized'
+        '422':
+          description: |-
+            The template could not be rendered, for example because it calls a helper that does not
+            exist ('Missing helper: "first"').
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
 components:
   securitySchemes:
     bearerAuth:
@@ -1219,6 +1426,46 @@ components:
         traceKeysDuplicate:
           type: boolean
           description: When true, duplicate trace keys were detected in the output records.
+    Error:
+      type: object
+      description: Standard error response envelope returned by integrator.io APIs.
+      properties:
+        errors:
+          type: array
+          description: List of errors that occurred while processing the request.
+          items:
+            type: object
+            properties:
+              code:
+                oneOf:
+                  - type: string
+                  - type: integer
+                description: |-
+                  Machine-readable error code. Usually a string like
+                  `invalid_ref`, `missing_required_field`, or `unauthorized`;
+                  may be an **integer** when the error mirrors an upstream HTTP
+                  status (e.g. `500`) — most commonly returned by connection-ping
+                  and adaptor-proxy responses.
+              message:
+                type: string
+                description: Human-readable description of the error.
+              field:
+                type: string
+                description: |-
+                  Optional pointer to the document field that caused the error.
+                  Used by structural validation errors (`missing_required_field`,
+                  `invalid_ref`) to indicate which field is at fault
+                  (e.g. `_id`, `type`, `http.baseURI`).
+              source:
+                type: string
+                description: |-
+                  Optional origin layer for the error — e.g. `application` when
+                  the error came from the remote system the adaptor called,
+                  `connector` when the adaptor itself rejected the request.
+            required:
+              - message
+      required:
+        - errors
   responses:
     401-unauthorized:
       description: |-

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