Doc fix on visibility in conversationCreate (#6315)

* Doc fix on visibility in conversationCreate * Fix example * Generate swagger.json * Remove default
dust-tt · Aug 28, 2024 · 382580b · 382580b
1 parent c37ac54
commit 382580b
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 13 deletions.
diff --git a/front/pages/api/v1/w/[wId]/assistant/conversations/index.ts b/front/pages/api/v1/w/[wId]/assistant/conversations/index.ts
@@ -58,8 +58,7 @@ export type PostConversationsResponseBody = {
  *                 $ref: '#/components/schemas/ContentFragment'
  *               blocking:
  *                 type: boolean
- *                 description: Whether to wait for the agent to generate the initial message
- *                 default: false
+ *                 description: Whether to wait for the agent to generate the initial message (if blocking = false, you will need to use streaming events to get the messages)
  *                 example: true
  *               title:
  *                 type: string
@@ -68,13 +67,11 @@ export type PostConversationsResponseBody = {
  *                 example: My conversation
  *               visibility:
  *                 type: string
- *                 description: The visibility of the conversation
+ *                 description: The visibility of the conversation (The API only accepts `unlisted`)
  *                 enum:
- *                   - public
- *                   - private
+ *                   - workspace
  *                   - unlisted
- *                 default: public
- *                 example: private
+ *                 example: unlisted
  *     responses:
  *       200:
  *         description: Conversation created successfully.

diff --git a/front/public/swagger.json b/front/public/swagger.json
@@ -717,8 +717,7 @@
                   },
                   "blocking": {
                     "type": "boolean",
-                    "description": "Whether to wait for the agent to generate the initial message",
-                    "default": false,
+                    "description": "Whether to wait for the agent to generate the initial message (if blocking = false, you will need to use streaming events to get the messages)",
                     "example": true
                   },
                   "title": {
@@ -729,10 +728,9 @@
                   },
                   "visibility": {
                     "type": "string",
-                    "description": "The visibility of the conversation",
-                    "enum": ["public", "private", "unlisted"],
-                    "default": "public",
-                    "example": "private"
+                    "description": "The visibility of the conversation (The API only accepts `unlisted`)",
+                    "enum": ["workspace", "unlisted"],
+                    "example": "unlisted"
                   }
                 }
               }