📝 Add a note on where to find resultId

baptisteArno · Jan 4, 2024 · 2385eaf · 2385eaf
1 parent b2c732a
commit 2385eaf
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git 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
@@ -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
           }