Fix webhook wait response schema

topher-lo · topher-lo · commit 6a69958dec69 · 2026-04-20T10:52:21.000-04:00
diff --git a/frontend/src/client/schemas.gen.ts b/frontend/src/client/schemas.gen.ts
@@ -21894,34 +21894,6 @@ export const $WaitResultUnwrapOverflowResponse = {
   title: "WaitResultUnwrapOverflowResponse",
 } as const
 
-export const $WaitResultUnwrappedOutput = {
-  anyOf: [
-    {
-      additionalProperties: true,
-      type: "object",
-    },
-    {
-      items: {},
-      type: "array",
-    },
-    {
-      type: "string",
-    },
-    {
-      type: "integer",
-    },
-    {
-      type: "number",
-    },
-    {
-      type: "boolean",
-    },
-    {
-      type: "null",
-    },
-  ],
-} as const
-
 export const $WaitStrategy = {
   type: "string",
   enum: ["wait", "detach"],
diff --git a/frontend/src/client/services.gen.ts b/frontend/src/client/services.gen.ts
@@ -817,7 +817,7 @@ export const publicIncomingWebhookGet = (
  * @param data.workflowId
  * @param data.unwrap Return the workflow result directly as the response body, without the `{kind, value}` envelope. Requires the result to fit inline. If the result was externalized, returns 413 with the download envelope in `detail`.
  * @param data.contentType
- * @returns unknown Successful Response
+ * @returns WaitResultOutput Successful Response
  * @throws ApiError
  */
 export const publicIncomingWebhookWait = (
diff --git a/frontend/src/client/types.gen.ts b/frontend/src/client/types.gen.ts
@@ -6762,16 +6762,6 @@ export type WaitResultUnwrapOverflowResponse = {
   detail: WebhookStoredObjectDownloadResponse
 }
 
-export type WaitResultUnwrappedOutput =
-  | {
-      [key: string]: unknown
-    }
-  | Array<unknown>
-  | string
-  | number
-  | boolean
-  | null
-
 export type WaitStrategy = "wait" | "detach"
 
 /**
@@ -8004,9 +7994,7 @@ export type PublicIncomingWebhookWaitData = {
   workflowId: string
 }
 
-export type PublicIncomingWebhookWaitResponse =
-  | WaitResultOutput
-  | WaitResultUnwrappedOutput
+export type PublicIncomingWebhookWaitResponse = WaitResultOutput
 
 export type PublicIncomingWebhookDraftData = {
   contentType?: string | null
@@ -10980,7 +10968,7 @@ export type $OpenApiTs = {
         /**
          * Successful Response
          */
-        200: WaitResultOutput | WaitResultUnwrappedOutput
+        200: WaitResultOutput
         /**
          * Unwrapped workflow result exceeded inline response limits. Use `detail.download_url` to fetch the externalized result.
          */
diff --git a/tests/unit/test_webhook_execution_path.py b/tests/unit/test_webhook_execution_path.py
@@ -19,7 +19,7 @@
 from unittest.mock import AsyncMock, MagicMock, patch
 
 import pytest
-from fastapi import HTTPException, Request
+from fastapi import FastAPI, HTTPException, Request
 from fastapi.responses import JSONResponse
 from temporalio.client import Client
 from temporalio.common import TypedSearchAttributes, WorkflowIDReusePolicy
@@ -37,6 +37,7 @@
 )
 from tracecat.storage.utils import deserialize_object
 from tracecat.webhooks.router import _incoming_webhook, incoming_webhook_wait
+from tracecat.webhooks.router import router as webhook_router
 from tracecat.workflow.executions.enums import (
     ExecutionType,
     TemporalSearchAttr,
@@ -1051,6 +1052,22 @@ async def test_wait_webhook_unwrap_returns_413_for_collection_object(self):
         assert detail["kind"] == "download_export"
         assert detail["download_url"] == "https://example.com/presigned/collection"
 
+    def test_wait_webhook_openapi_keeps_default_200_schema_enveloped(self):
+        """The default /wait 200 schema should stay discriminated for generated clients."""
+        app = FastAPI()
+        app.include_router(webhook_router)
+
+        responses = app.openapi()["paths"]["/webhooks/{workflow_id}/{secret}/wait"][
+            "post"
+        ]["responses"]
+        success_schema = responses["200"]["content"]["application/json"]["schema"]
+        overflow_schema = responses["413"]["content"]["application/json"]["schema"]
+
+        assert success_schema == {"$ref": "#/components/schemas/WaitResultOutput"}
+        assert overflow_schema == {
+            "$ref": "#/components/schemas/WaitResultUnwrapOverflowResponse"
+        }
+
 
 # ---------------------------------------------------------------------------
 # _dispatch_workflow invariants (for /wait webhook endpoint)
diff --git a/tracecat/webhooks/router.py b/tracecat/webhooks/router.py
@@ -396,7 +396,7 @@ async def _incoming_webhook(
 
 @router.post(
     "/wait",
-    response_model=WaitResultOutput | WaitResultUnwrappedOutput,
+    response_model=WaitResultOutput,
     responses={
         status.HTTP_413_REQUEST_ENTITY_TOO_LARGE: {
             "model": WaitResultUnwrapOverflowResponse,
