From 2385eaf7d52a92ad64640690b43e21f749f7a431 Mon Sep 17 00:00:00 2001 From: Baptiste Arnaud Date: Thu, 4 Jan 2024 20:48:56 +0100 Subject: [PATCH] :pencil: Add a note on where to find resultId --- apps/builder/src/features/results/api/getResult.ts | 6 +++++- apps/docs/openapi/builder.json | 3 ++- 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/apps/builder/src/features/results/api/getResult.ts b/apps/builder/src/features/results/api/getResult.ts index e45f31ea9..fd0bcedb7 100644 --- a/apps/builder/src/features/results/api/getResult.ts +++ b/apps/builder/src/features/results/api/getResult.ts @@ -22,7 +22,11 @@ export const getResult = authenticatedProcedure .describe( "[Where to find my bot's ID?](../how-to#how-to-find-my-typebotid)" ), - resultId: z.string(), + resultId: z + .string() + .describe( + 'The `resultId` is returned by the /startChat endpoint or you can find it by listing results with `/results` endpoint' + ), }) ) .output( diff --git a/apps/docs/openapi/builder.json b/apps/docs/openapi/builder.json index e8f8438a0..f07afc032 100644 --- a/apps/docs/openapi/builder.json +++ b/apps/docs/openapi/builder.json @@ -15494,7 +15494,8 @@ "in": "path", "name": "resultId", "schema": { - "type": "string" + "type": "string", + "description": "The `resultId` is returned by the /startChat endpoint or you can find it by listing results with `/results` endpoint" }, "required": true }