From 2fbe00545ec03eec148f2cfa3c5e0639173ab33b Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Wed, 21 Oct 2026 23:53:45 +0000 Subject: [PATCH] docs: document success flag on automation webhook error responses --- admin-openapi.json | 34 +++++++++++++++++++++++++++++----- 1 file changed, 29 insertions(+), 5 deletions(-) diff --git a/admin-openapi.json b/admin-openapi.json index 3336b72881..932b8f7425 100644 --- a/admin-openapi.json +++ b/admin-openapi.json @@ -592,7 +592,8 @@ "type": "object", "properties": { "success": { - "type": "boolean" + "type": "boolean", + "description": "Always `true` when the run is queued." }, "runId": { "type": "string", @@ -608,7 +609,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Error" + "$ref": "#/components/schemas/AutomationWebhookError" } } } @@ -618,7 +619,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Error" + "$ref": "#/components/schemas/AutomationWebhookError" } } } @@ -628,7 +629,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Error" + "$ref": "#/components/schemas/AutomationWebhookError" } } } @@ -638,7 +639,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Error" + "$ref": "#/components/schemas/AutomationWebhookError" + } + } + } + }, + "500": { + "description": "The automation run could not be queued because of an unexpected server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AutomationWebhookError" } } } @@ -700,6 +711,19 @@ } } }, + "AutomationWebhookError": { + "type": "object", + "properties": { + "success": { + "type": "boolean", + "description": "Always `false` for error responses." + }, + "error": { + "type": "string", + "description": "Error message." + } + } + }, "Error": { "type": "object", "properties": {