Add tags on new endpoints + add required fields on context (#9004)

* Update tags docs * Make context required
dust-tt · Nov 28, 2024 · 8555f22 · 8555f22
1 parent 149b1a3
commit 8555f22
Show file tree

Hide file tree

Showing 5 changed files with 30 additions and 0 deletions.
diff --git a/front/pages/api/v1/w/[wId]/assistant/conversations/[cId]/cancel.ts b/front/pages/api/v1/w/[wId]/assistant/conversations/[cId]/cancel.ts
@@ -14,6 +14,8 @@ import { apiError } from "@app/logger/withlogging";
  * @swagger
  * /api/v1/w/{wId}/assistant/conversations/{cId}/cancel:
  *   post:
+ *     tags:
+ *       - Conversations
  *     summary: Cancel message generation in a conversation
  *     parameters:
  *       - name: wId

diff --git a/front/pages/api/v1/w/[wId]/assistant/conversations/[cId]/messages/[mId]/edit.ts b/front/pages/api/v1/w/[wId]/assistant/conversations/[cId]/messages/[mId]/edit.ts
@@ -15,6 +15,8 @@ import { apiError } from "@app/logger/withlogging";
  * @swagger
  * /api/v1/w/{wId}/assistant/conversations/{cId}/messages/{mId}/edit:
  *   post:
+ *     tags:
+ *       - Conversations
  *     summary: Edit an existing message in a conversation
  *     parameters:
  *       - name: wId

diff --git a/front/pages/api/v1/w/[wId]/files/index.ts b/front/pages/api/v1/w/[wId]/files/index.ts
@@ -19,6 +19,8 @@ import { apiError } from "@app/logger/withlogging";
  * @swagger
  * /api/v1/w/{wId}/files:
  *   post:
+ *     tags:
+ *       - Datasources
  *     summary: Create a file upload URL
  *     parameters:
  *       - name: wId

diff --git a/front/pages/api/v1/w/[wId]/swagger_schemas.ts b/front/pages/api/v1/w/[wId]/swagger_schemas.ts
@@ -93,6 +93,13 @@
  *           example: "openai"
  *     Context:
  *       type: object
+ *       required:
+ *         - username
+ *         - timezone
+ *         - fullName
+ *         - email
+ *         - profilePictureUrl
+ *         - origin
  *       properties:
  *         username:
  *           type: string

diff --git a/front/public/swagger.json b/front/public/swagger.json
@@ -304,6 +304,9 @@
     },
     "/api/v1/w/{wId}/assistant/conversations/{cId}/cancel": {
       "post": {
+        "tags": [
+          "Conversations"
+        ],
         "summary": "Cancel message generation in a conversation",
         "parameters": [
           {
@@ -560,6 +563,9 @@
     },
     "/api/v1/w/{wId}/assistant/conversations/{cId}/messages/{mId}/edit": {
       "post": {
+        "tags": [
+          "Conversations"
+        ],
         "summary": "Edit an existing message in a conversation",
         "parameters": [
           {
@@ -912,6 +918,9 @@
     },
     "/api/v1/w/{wId}/files": {
       "post": {
+        "tags": [
+          "Datasources"
+        ],
         "summary": "Create a file upload URL",
         "parameters": [
           {
@@ -3519,6 +3528,14 @@
       },
       "Context": {
         "type": "object",
+        "required": [
+          "username",
+          "timezone",
+          "fullName",
+          "email",
+          "profilePictureUrl",
+          "origin"
+        ],
         "properties": {
           "username": {
             "type": "string",