@celigo/api-specs 0.2.38 → 0.2.40

package/dist/flow.yml

@@ -63,10 +63,14 @@ paths:
         - name: name
           in: query
           description: |-
-            Filter by name — a substring match, not an exact match. An empty
-            value is ignored.
+            Filter to flows whose name contains this value — a case-insensitive
+            substring match, not an exact match; regex metacharacters match
+            literally and surrounding whitespace is trimmed. An empty value is
+            ignored; a value longer than the maximum is rejected with 400
+            `invalid_query_param`.
           schema:
             type: string
+            maxLength: 150
             examples:
               - Order
         - name: disabled
@@ -166,7 +170,9 @@ paths:
                       logging:
                         mode: accountLevel
         '204':
-          description: No flows exist in the account.
+          description: No flows match — the account has none, or the filters excluded every flow.
+        '400':
+          $ref: '#/components/responses/400-bad-request'
         '401':
           $ref: '#/components/responses/401-unauthorized'
     post:
@@ -181,11 +187,19 @@ paths:
         abstract/instance patterns, create the abstract flow first, then create instances with
         `_abstractFlowId`.
 
-        When `_integrationId` is omitted, the flow is auto-assigned to the
+        When `_integrationId` is omitted or `null`, the flow is auto-assigned to the
         account's "Standalone flows" integration rather than left standalone.
         If that migration integration does not exist on the account, the
-        request fails with `422 standalone_flows_not_supported`. Always pass an
-        explicit `_integrationId`.
+        request fails with `422 standalone_flows_not_supported`. A value that is
+        not a well-formed ObjectId is rejected with `400 invalid_ref` before the
+        flow is validated, and an id that names no integration in the account
+        fails with `422 invalid_ref`. Always pass an explicit `_integrationId`.
+
+        `schedule` is validated on every write even when `disabled` is true, so a
+        disabled flow cannot be parked with a broken schedule: `422 invalid_value`
+        when the expression cannot be parsed into a schedule, `422
+        schedule_not_supported` when its runs would be less than a minute apart
+        (which is also what free text produces).
       operationId: createFlow
       tags:
         - Flows
@@ -4673,7 +4687,11 @@ components:
                   - 66a1f2c3b4d5e6f7a8b9c0d1
               schedule:
                 type: string
-                description: Override the export's schedule
+                description: |-
+                  Replaces the page generator's schedule for this instance, in the same
+                  Celigo 6-field cron format as the flow-level `schedule`. Parsed on every
+                  write regardless of `disabled`; an unparseable expression fails with
+                  `422 invalid_value` at `overrides.exports[i].schedule`.
                 examples:
                   - '? 5 0,4,8,12,16,20 ? * *'
               skipRetries:
@@ -5154,15 +5172,20 @@ components:
           format: objectId
           x-celigo-refModel: integrations
           description: |-
-            Integration this flow belongs to. Omitting it on create no longer
-            produces a standalone flow — the flow is auto-assigned to the
-            account's "Standalone flows" integration (or the create fails with
-            `422 standalone_flows_not_supported` when that integration is
-            missing). Always set it explicitly.
+            Integration this flow belongs to. Omitting it (or sending `null`) on
+            create no longer produces a standalone flow — the flow is auto-assigned
+            to the account's "Standalone flows" integration (or the create fails
+            with `422 standalone_flows_not_supported` when that integration is
+            missing). A value that is not a well-formed ObjectId is rejected with
+            `400 invalid_ref` rather than auto-assigned. Always set it explicitly.
           examples:
             - 60a2c4e6f321d800129a1a3c
           x-celigo-ai-guidance:
             - To move the flow to a different integration, PUT with a changed _integrationId AND remove _flowGroupingId (flow groups are per-integration; a stale value is rejected with 422 flowgrouping_not_belong). The platform registers the flow's step connections in the target integration on save.
+            - |-
+              Send a real integration id: a malformed value fails with 400 `invalid_ref`
+              ("Please provide a valid _integrationId."), and a well-formed id that names
+              no integration in the account fails with 422 `invalid_ref`.
         schedule:
           type:
             - string
@@ -5170,13 +5193,24 @@ components:
           description: |-
             Celigo 6-field cron expression: `? minute hour day-of-month month day-of-week`.
             Explicit minute/hour lists, ranges, wildcards, and step forms (`*/N`) are all valid.
-            Leave empty for event-driven or webhook-triggered flows.
+            Leave empty for event-driven or webhook-triggered flows. Validated on every
+            write, including while `disabled` is true, so a flow cannot be parked disabled
+            with a broken schedule: `422 invalid_value` when the expression cannot be parsed
+            into a schedule (for example all wildcards, `? * * ? * *`), `422
+            schedule_not_supported` when its runs would be less than a minute apart — which
+            is also what free text such as `every 5 minutes` produces.
           x-celigo-ai-guidance:
             - |-
               Build `schedule` as a Celigo 6-field cron:
               `? minute hour day-of-month month day-of-week`.
               The seconds field is always `?`; day-of-month is usually `?`, month `*`,
               and day-of-week `*` (or specific days, 0=Sun..6=Sat).
+            - |-
+              Disabling a flow does not bypass schedule validation: POST, PUT, and PATCH
+              all reject free text or a sub-minute expression (`not a cron`, `* * * * * *`)
+              with 422 `schedule_not_supported`, and an expression that parses to no
+              schedule (`? * * ? * *`) with 422 `invalid_value`. Fix or clear the schedule
+              instead of disabling the flow to get past the error.
             - |-
               Prefer explicit lists when AUTHORING a schedule — hourly or longer:
               minute `5` with an explicit hour list
@@ -5640,17 +5674,6 @@ components:
               description: Source resource this flow was cloned or installed from.
               examples:
                 - 60a2c4e6f321d800129a1a3c
-    Request:
-      type: object
-      description: |-
-        Fields for creating or updating a flow.
-
-        Use `pageProcessors` for simple linear flows or `routers` for conditional branching — never
-        include both. The `schedule` field uses Celigo's 6-field cron format (not standard 5-field).
-      required:
-        - name
-      allOf:
-        - $ref: '#/components/schemas/FlowBase'
     Error:
       type: object
       description: Standard error response envelope returned by integrator.io APIs.
@@ -5691,6 +5714,17 @@ components:
               - message
       required:
         - errors
+    Request:
+      type: object
+      description: |-
+        Fields for creating or updating a flow.
+
+        Use `pageProcessors` for simple linear flows or `routers` for conditional branching — never
+        include both. The `schedule` field uses Celigo's 6-field cron format (not standard 5-field).
+      required:
+        - name
+      allOf:
+        - $ref: '#/components/schemas/FlowBase'
     JsonPatchOperation:
       type: object
       description: A single JSON Patch operation (RFC 6902).
@@ -7839,6 +7873,13 @@ components:
           description: Display name of the dependent resource.
           examples:
             - Import Orders to NetSuite
+        type:
+          type: string
+          description: |-
+            Sub-type of the dependent resource when its collection distinguishes one, such as
+            `stream` for a listener export. Only present for resource types that carry a `type`.
+          examples:
+            - stream
         paths:
           type: array
           description: |-
@@ -7902,6 +7943,19 @@ components:
               export:
                 - 64ff4b21612a134bd2f45534
   responses:
+    400-bad-request:
+      description: |
+        Bad request. The server could not understand the request because of malformed syntax or invalid parameters.
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/Error'
+          examples:
+            default:
+              value:
+                errors:
+                  - code: invalid_request
+                    message: The request body failed validation.
     401-unauthorized:
       description: |-
         Unauthorized. The request lacks a valid bearer token, or the provided token
@@ -7936,19 +7990,6 @@ components:
               summary: Bearer token invalid or revoked
               value:
                 message: Bearer Authentication Failed
-    400-bad-request:
-      description: |
-        Bad request. The server could not understand the request because of malformed syntax or invalid parameters.
-      content:
-        application/json:
-          schema:
-            $ref: '#/components/schemas/Error'
-          examples:
-            default:
-              value:
-                errors:
-                  - code: invalid_request
-                    message: The request body failed validation.
     422-unprocessable-entity:
       description: |
         Unprocessable entity. The request was well-formed but was unable to be followed due to semantic errors.