@celigo/api-specs 0.2.201 → 0.2.203

package/dist/agent.yml

@@ -253,10 +253,39 @@ paths:
                     _agentExtensionId: 68fb235610b42b2eaa6525c2
                     port: '7020'
                     lastHeartbeatAt: '2026-05-15T12:00:00.000Z'
+        '400':
+          description: '`_id` is not a valid ObjectId.'
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+              examples:
+                malformed-id:
+                  value:
+                    errors:
+                      - code: invalid_ref
+                        message: Please provide a valid _id.
         '401':
           $ref: '#/components/responses/401-unauthorized'
         '404':
-          $ref: '#/components/responses/404-not-found'
+          description: |-
+            No agent has this id in the account. An agent in the recycle bin
+            answers with the recycle-bin message instead.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+              examples:
+                not-found:
+                  value:
+                    errors:
+                      - code: invalid_ref
+                        message: On-premise agent not found for the given id.
+                in-recycle-bin:
+                  value:
+                    errors:
+                      - code: invalid_ref
+                        message: You are trying to access an on-premise agent that is already in the Recycle Bin. Please restore it from the Recycle Bin and try your request again.
     put:
       x-internal: false
       summary: Update an on-premise agent
@@ -310,11 +339,26 @@ paths:
                     port: '7020'
                     lastHeartbeatAt: '2026-05-15T12:00:00.000Z'
         '400':
-          $ref: '#/components/responses/400-bad-request'
+          description: The body is not a JSON object, or `_id` is not a valid ObjectId.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+              examples:
+                body-not-object:
+                  value:
+                    errors:
+                      - code: invalid_request
+                        message: Agent document should be a JSON object.
+                malformed-id:
+                  value:
+                    errors:
+                      - code: invalid_ref
+                        message: Please provide a valid _id.
         '401':
           $ref: '#/components/responses/401-unauthorized'
         '404':
-          $ref: '#/components/responses/404-not-found'
+          $ref: '#/components/responses/404-agent-not-found'
     delete:
       x-internal: false
       summary: Delete an on-premise agent
@@ -338,10 +382,34 @@ paths:
       responses:
         '204':
           description: Agent deleted.
+        '400':
+          description: '`_id` is not a valid ObjectId.'
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+              examples:
+                malformed-id:
+                  value:
+                    errors:
+                      - code: invalid_ref
+                        message: Please provide a valid _id.
         '401':
           $ref: '#/components/responses/401-unauthorized'
         '404':
-          $ref: '#/components/responses/404-not-found'
+          description: |-
+            No active agent has this id. An unknown id and an agent already in the
+            recycle bin both answer with the recycle-bin message.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+              examples:
+                not-active:
+                  value:
+                    errors:
+                      - code: invalid_ref
+                        message: You are trying to access an on-premise agent that is already in the Recycle Bin. Please restore it from the Recycle Bin and try your request again.
         '422':
           $ref: '#/components/responses/422-dependency-conflict'
   /v1/agents/{_id}/display-token:
@@ -379,7 +447,7 @@ paths:
         '401':
           $ref: '#/components/responses/401-unauthorized'
         '404':
-          $ref: '#/components/responses/404-not-found'
+          $ref: '#/components/responses/404-agent-not-found'
   /v1/agents/{_id}/change-token:
     put:
       x-internal: false
@@ -416,7 +484,7 @@ paths:
         '401':
           $ref: '#/components/responses/401-unauthorized'
         '404':
-          $ref: '#/components/responses/404-not-found'
+          $ref: '#/components/responses/404-agent-not-found'
   /v1/agents/{_id}/installer/signedURL:
     get:
       x-internal: false
@@ -467,7 +535,7 @@ paths:
         '401':
           $ref: '#/components/responses/401-unauthorized'
         '404':
-          $ref: '#/components/responses/404-not-found'
+          $ref: '#/components/responses/404-agent-not-found'
         '422':
           $ref: '#/components/responses/422-unprocessable-entity'
   /v1/agents/{_id}/dependencies:
@@ -888,19 +956,18 @@ components:
                 errors:
                   - code: invalid_request
                     message: The request body failed validation.
-    404-not-found:
-      description: |
-        Not found. The requested resource does not exist or is not visible to the caller.
+    404-agent-not-found:
+      description: No on-premise agent has this id in the account.
       content:
         application/json:
           schema:
             $ref: '#/components/schemas/Error'
           examples:
-            default:
+            not-found:
               value:
                 errors:
-                  - code: not_found
-                    message: The requested resource was not found.
+                  - code: invalid_ref
+                    message: On-premise agent not found for the given id.
     422-dependency-conflict:
       description: |-
         The resource has dependents that must be deleted first. Each entry

package/dist/alert.yml

@@ -513,6 +513,10 @@ paths:
 
         Requires permission to read the alert (`get:alert:model`). Returns `403`
         when `ENABLE_PROACTIVE_ALERTS` is off or the caller lacks access.
+
+        The history stays readable after the alert is deleted, even though the alert
+        itself then reads 404. The same entries also appear in the integration's audit
+        log (`GET /v1/integrations/{_id}/audit`).
       parameters:
         - name: _id
           in: path
@@ -604,6 +608,14 @@ paths:
                       description: Alert id.
                       examples:
                         - 674a1b2c3d4e5f6789012345
+                    resourceName:
+                      type: string
+                      description: |-
+                        Display name of the alert: `<type label> - <flow name>` for a flow-level
+                        alert, `<type label> - All flows (<integration name>)` for an
+                        integration-level alert.
+                      examples:
+                        - Long runtime - All flows (Shopify to NetSuite)
                     event:
                       type: string
                       description: Mutation event type.
@@ -664,26 +676,41 @@ paths:
                         properties:
                           fieldPath:
                             type: string
-                            description: Dot-notation path of the changed field.
+                            description: |-
+                              Dot-notation path of the changed field. A recipient change is reported
+                              as `recipients`, listing the recipients' email addresses instead of user
+                              ids.
                             examples:
-                              - longRuntime.thresholdMinutes
+                              - longRuntime
                           oldValue:
                             description: Previous value (absent on create).
                           newValue:
                             description: New value (absent on delete).
                     deletedInfo:
                       type: object
-                      description: Metadata about the deleted resource. Present on `delete` events.
+                      description: |-
+                        Metadata about the deleted alert. Once the alert is deleted, every entry in its
+                        history carries it, not only the `delete` entry.
                       properties:
                         name:
                           type: string
-                          description: Name of the resource at the time of deletion.
+                          description: Display name of the alert at the time of deletion.
+                          examples:
+                            - Long runtime - All flows (Shopify to NetSuite)
+                        _integrationId:
+                          type: string
+                          format: objectId
+                          x-celigo-refModel: integrations
+                          description: Integration the alert belonged to.
+                          examples:
+                            - 5e5eb06fdd83ed4f8206a4ea
               examples:
                 default:
                   value:
                     - _id: 69e38cb1a749d34a9732a270
                       resourceType: alert
                       _resourceId: 674a1b2c3d4e5f6789012345
+                      resourceName: Long runtime - All flows (Shopify to NetSuite)
                       source: api
                       event: update
                       time: '2026-04-18T13:52:49.729Z'
@@ -692,9 +719,11 @@ paths:
                         email: user@example.com
                         name: Jane Doe
                       fieldChanges:
-                        - fieldPath: longRuntime.thresholdMinutes
-                          oldValue: 30
-                          newValue: 45
+                        - fieldPath: longRuntime
+                          oldValue:
+                            thresholdMinutes: 30
+                          newValue:
+                            thresholdMinutes: 45
         '204':
           description: No audit entries exist for this alert.
         '400':

package/dist/audit.yml

@@ -104,7 +104,6 @@ paths:
               - import
               - integration
               - lookupcache
-              - mcpoauthprovider
               - mcpserver
               - networkpolicy
               - notification
@@ -142,10 +141,9 @@ paths:
               import: Import resource for writing data to a destination system.
               integration: Integration workspace resource.
               lookupcache: Lookup cache resource for in-memory key-value stores.
-              mcpoauthprovider: MCP OAuth provider resource.
               mcpserver: MCP server resource for AI agent tool hosting.
               networkpolicy: Network policy resource (IP allow/deny lists).
-              notification: Notification subscription resource.
+              notification: Notification subscription resource. Filtering on `alert` also returns these entries.
               revision: Revision snapshot resource for version control.
               role: End-user role resource.
               script: Script resource for custom JavaScript hooks.
@@ -547,7 +545,6 @@ paths:
               - import
               - integration
               - lookupcache
-              - mcpoauthprovider
               - mcpserver
               - notification
               - revision
@@ -582,9 +579,8 @@ paths:
               import: Import resource for writing data to a destination system.
               integration: Integration workspace resource.
               lookupcache: Lookup cache resource for in-memory key-value stores.
-              mcpoauthprovider: MCP OAuth provider resource.
               mcpserver: MCP server resource for AI agent tool hosting.
-              notification: Notification subscription resource.
+              notification: Notification subscription resource. Filtering on `alert` also returns these entries.
               revision: Revision snapshot resource for version control.
               role: End-user role resource.
               script: Script resource for custom JavaScript hooks.
@@ -822,7 +818,6 @@ paths:
               - imports
               - integrations
               - lookupcaches
-              - mcpoauthproviders
               - mcpservers
               - networkpolicies
               - revisions
@@ -850,9 +845,8 @@ paths:
               iclients: iClient shared credential resources.
               idpconfigs: End-user identity provider configuration resources.
               imports: Import resources.
-              integrations: Integration workspace resources.
+              integrations: Integration workspace resources. The history also includes the alerts set on the integration or its flows, deleted ones too.
               lookupcaches: Lookup cache resources.
-              mcpoauthproviders: MCP OAuth provider resources.
               mcpservers: MCP server resources.
               networkpolicies: Network policy resources.
               revisions: Revision snapshot resources.
@@ -1060,7 +1054,6 @@ paths:
               - imports
               - integrations
               - lookupcaches
-              - mcpoauthproviders
               - mcpservers
               - networkpolicies
               - revisions
@@ -1088,9 +1081,8 @@ paths:
               iclients: iClient shared credential resources.
               idpconfigs: End-user identity provider configuration resources.
               imports: Import resources.
-              integrations: Integration workspace resources.
+              integrations: Integration workspace resources. The history also includes the alerts set on the integration or its flows, deleted ones too.
               lookupcaches: Lookup cache resources.
-              mcpoauthproviders: MCP OAuth provider resources.
               mcpservers: MCP server resources.
               networkpolicies: Network policy resources.
               revisions: Revision snapshot resources.
@@ -1286,7 +1278,6 @@ paths:
               - imports
               - integrations
               - lookupcaches
-              - mcpoauthproviders
               - mcpservers
               - networkpolicies
               - revisions
@@ -1312,9 +1303,8 @@ paths:
               iclients: iClient shared credential resources.
               idpconfigs: End-user identity provider configuration resources.
               imports: Import resources.
-              integrations: Integration workspace resources.
+              integrations: Integration workspace resources. The export also includes the alerts set on the integration or its flows, deleted ones too.
               lookupcaches: Lookup cache resources.
-              mcpoauthproviders: MCP OAuth provider resources.
               mcpservers: MCP server resources.
               networkpolicies: Network policy resources.
               revisions: Revision snapshot resources.
@@ -1377,7 +1367,10 @@ components:
       properties:
         fieldPath:
           type: string
-          description: Dot-path to the changed field (e.g., `settings.foo.bar`).
+          description: |-
+            Dot-path to the changed field (e.g., `settings.foo.bar`). On `alert` entries a recipient
+            change is reported as `recipients`, with `oldValue` and `newValue` listing the recipients'
+            email addresses instead of user ids.
           examples:
             - http.auth.token.token
         oldValue:
@@ -1397,7 +1390,7 @@ components:
           type: string
           format: objectId
           x-celigo-refModel: integrations
-          description: Integration id context (for flow/sync-related events).
+          description: Integration id context (for flow/sync-related and alert events).
           examples:
             - 60a2c4e6f321d800129a1a3c
         _abstractFlowId:
@@ -1459,8 +1452,11 @@ components:
           type: string
           readOnly: true
           description: |-
-            Resource type that the audit entry applies to. `fileserver` appears only in
-            returned entries and cannot be used as a `resourceType` filter.
+            Resource type that the audit entry applies to. `fileserver` and
+            `mcpoauthprovider` appear only in returned entries and cannot be used as a
+            `resourceType` filter. MCP OAuth providers have no per-resource audit route
+            either, so their entries are read from `GET /v1/audit` without a
+            `resourceType` filter.
           enum:
             - accesstoken
             - agent
@@ -1542,6 +1538,15 @@ components:
           description: Resource id the audit entry applies to.
           examples:
             - 69497ca1b40d3e24522a7f3c
+        resourceName:
+          type: string
+          readOnly: true
+          description: |-
+            Display name of the alert, present on `alert` entries only: `<type label> - <flow name>`
+            for a flow-level alert, `<type label> - All flows (<integration name>)` for an
+            integration-level alert.
+          examples:
+            - Long runtime - All flows (Shopify to NetSuite)
         source:
           type: string
           readOnly: true
@@ -1692,7 +1697,6 @@ components:
               - import
               - integration
               - lookupcache
-              - mcpoauthprovider
               - mcpserver
               - networkpolicy
               - notification
@@ -1728,10 +1732,9 @@ components:
               import: Import resource for writing data to a destination system.
               integration: Integration workspace resource.
               lookupcache: Lookup cache resource for in-memory key-value stores.
-              mcpoauthprovider: MCP OAuth provider resource.
               mcpserver: MCP server resource for AI agent tool hosting.
               networkpolicy: Network policy resource (IP allow/deny lists).
-              notification: Notification subscription resource.
+              notification: Notification subscription resource. Filtering on `alert` also returns these entries.
               revision: Revision snapshot resource for version control.
               role: End-user role resource.
               script: Script resource for custom JavaScript hooks.
@@ -1915,7 +1918,6 @@ components:
             - import
             - integration
             - lookupcache
-            - mcpoauthprovider
             - mcpserver
             - networkpolicy
             - notification
@@ -1951,10 +1953,9 @@ components:
             import: Import resource for writing data to a destination system.
             integration: Integration workspace resource.
             lookupcache: Lookup cache resource for in-memory key-value stores.
-            mcpoauthprovider: MCP OAuth provider resource.
             mcpserver: MCP server resource for AI agent tool hosting.
             networkpolicy: Network policy resource (IP allow/deny lists).
-            notification: Notification subscription resource.
+            notification: Notification subscription resource. Filtering on `alert` also returns these entries.
             revision: Revision snapshot resource for version control.
             role: End-user role resource.
             script: Script resource for custom JavaScript hooks.