Improve error message in public api, fix public api typing (#9086)

dust-tt · Dec 3, 2024 · f363ccf · f363ccf
1 parent e6fc57f
commit f363ccf
Show file tree

Hide file tree

Showing 24 changed files with 64 additions and 38 deletions.
diff --git a/front/pages/api/poke/workspaces/[wId]/data_sources/[dsId]/search.ts b/front/pages/api/poke/workspaces/[wId]/data_sources/[dsId]/search.ts
@@ -69,7 +69,8 @@ async function handler(
           status_code: 400,
           api_error: {
             type: "invalid_request_error",
-            message: `Invalid request body: ${r.error.message}`,
+            message: "Invalid request body.",
+            request_format_errors: r.error.flatten(),
           },
         });
       }

diff --git a/front/pages/api/v1/w/[wId]/assistant/agent_configurations/[sId]/index.ts b/front/pages/api/v1/w/[wId]/assistant/agent_configurations/[sId]/index.ts
@@ -145,7 +145,8 @@ async function handler(
           status_code: 400,
           api_error: {
             type: "invalid_request_error",
-            message: `Invalid request body: ${r.error.message}`,
+            message: "Invalid request body.",
+            request_format_errors: r.error.flatten(),
           },
         });
       }

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
@@ -97,7 +97,8 @@ async function handler(
           status_code: 400,
           api_error: {
             type: "invalid_request_error",
-            message: `Invalid request body: ${r.error.message}`,
+            message: "Invalid request body.",
+            request_format_errors: r.error.flatten(),
           },
         });
       }

diff --git a/front/pages/api/v1/w/[wId]/assistant/conversations/[cId]/content_fragments.ts b/front/pages/api/v1/w/[wId]/assistant/conversations/[cId]/content_fragments.ts
@@ -90,7 +90,8 @@ async function handler(
           status_code: 400,
           api_error: {
             type: "invalid_request_error",
-            message: `Invalid request body: ${r.error.message}`,
+            message: "Invalid request body.",
+            request_format_errors: r.error.flatten(),
           },
         });
       }

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
@@ -127,7 +127,8 @@ async function handler(
           status_code: 400,
           api_error: {
             type: "invalid_request_error",
-            message: `Invalid request body: ${r.error.message}`,
+            message: "Invalid request body.",
+            request_format_errors: r.error.flatten(),
           },
         });
       }

diff --git a/front/pages/api/v1/w/[wId]/assistant/conversations/[cId]/messages/index.ts b/front/pages/api/v1/w/[wId]/assistant/conversations/[cId]/messages/index.ts
@@ -87,7 +87,8 @@ async function handler(
           status_code: 400,
           api_error: {
             type: "invalid_request_error",
-            message: `Invalid request body: ${r.error.message}`,
+            message: "Invalid request body.",
+            request_format_errors: r.error.flatten(),
           },
         });
       }

diff --git a/front/pages/api/v1/w/[wId]/assistant/conversations/index.ts b/front/pages/api/v1/w/[wId]/assistant/conversations/index.ts
@@ -105,7 +105,8 @@ async function handler(
           status_code: 400,
           api_error: {
             type: "invalid_request_error",
-            message: `Invalid request body: ${r.error.message}`,
+            message: "Invalid request body.",
+            request_format_errors: r.error.flatten(),
           },
         });
       }
@@ -156,7 +157,7 @@ async function handler(
       }
 
       let conversation = await createConversation(auth, {
-        title,
+        title: title ?? null,
         visibility,
       });
 

diff --git a/front/pages/api/v1/w/[wId]/data_source_views/search.ts b/front/pages/api/v1/w/[wId]/data_source_views/search.ts
@@ -36,7 +36,8 @@ async function handler(
           status_code: 400,
           api_error: {
             type: "invalid_request_error",
-            message: `Invalid query parameters: ${r.error.message}`,
+            message: "Invalid query parameters.",
+            request_format_errors: r.error.flatten(),
           },
         });
       }

diff --git a/front/pages/api/v1/w/[wId]/files/index.ts b/front/pages/api/v1/w/[wId]/files/index.ts
@@ -95,7 +95,8 @@ async function handler(
           status_code: 400,
           api_error: {
             type: "invalid_request_error",
-            message: `Invalid request body: ${r.error.message}`,
+            message: "Invalid request body.",
+            request_format_errors: r.error.flatten(),
           },
         });
       }

diff --git a/front/pages/api/v1/w/[wId]/members/validate.ts b/front/pages/api/v1/w/[wId]/members/validate.ts
@@ -25,7 +25,8 @@ async function handler(
       status_code: 400,
       api_error: {
         type: "invalid_request_error",
-        message: `Invalid request body: ${r.error.message}`,
+        message: "Invalid request body.",
+        request_format_errors: r.error.flatten(),
       },
     });
   }

diff --git a/front/pages/api/v1/w/[wId]/spaces/[spaceId]/data_source_views/[dsvId]/index.ts b/front/pages/api/v1/w/[wId]/spaces/[spaceId]/data_source_views/[dsvId]/index.ts
@@ -203,7 +203,8 @@ async function handler(
           status_code: 400,
           api_error: {
             type: "invalid_request_error",
-            message: `Invalid request body: ${parsing.error.message}`,
+            message: "Invalid request body.",
+            request_format_errors: parsing.error.flatten(),
           },
         });
       }

diff --git a/front/pages/api/v1/w/[wId]/spaces/[spaceId]/data_source_views/[dsvId]/search.ts b/front/pages/api/v1/w/[wId]/spaces/[spaceId]/data_source_views/[dsvId]/search.ts
@@ -192,7 +192,8 @@ async function handler(
           status_code: 400,
           api_error: {
             type: "invalid_request_error",
-            message: `Invalid request body: ${r.error.message}`,
+            message: "Invalid request body.",
+            request_format_errors: r.error.flatten(),
           },
         });
       }

diff --git a/...pages/api/v1/w/[wId]/spaces/[spaceId]/data_sources/[dsId]/documents/[documentId]/index.ts b/...pages/api/v1/w/[wId]/spaces/[spaceId]/data_sources/[dsId]/documents/[documentId]/index.ts
@@ -378,7 +378,8 @@ async function handler(
           status_code: 400,
           api_error: {
             type: "invalid_request_error",
-            message: `Invalid request body: ${r.error.message}`,
+            message: "Invalid request body.",
+            request_format_errors: r.error.flatten(),
           },
         });
       }

diff --git a/front/pages/api/v1/w/[wId]/spaces/[spaceId]/data_sources/[dsId]/search.ts b/front/pages/api/v1/w/[wId]/spaces/[spaceId]/data_sources/[dsId]/search.ts
@@ -221,7 +221,8 @@ async function handler(
           status_code: 400,
           api_error: {
             type: "invalid_request_error",
-            message: `Invalid request body: ${r.error.message}`,
+            message: "Invalid request body.",
+            request_format_errors: r.error.flatten(),
           },
         });
       }

diff --git a/front/pages/api/v1/w/[wId]/spaces/[spaceId]/data_sources/[dsId]/tables/[tId]/parents.ts b/front/pages/api/v1/w/[wId]/spaces/[spaceId]/data_sources/[dsId]/tables/[tId]/parents.ts
@@ -94,7 +94,8 @@ async function handler(
           status_code: 400,
           api_error: {
             type: "invalid_request_error",
-            message: `Invalid request body: ${r.error.message}`,
+            message: "Invalid request body.",
+            request_format_errors: r.error.flatten(),
           },
         });
       }

diff --git a/front/pages/api/v1/w/[wId]/spaces/[spaceId]/data_sources/[dsId]/tables/[tId]/rows/index.ts b/front/pages/api/v1/w/[wId]/spaces/[spaceId]/data_sources/[dsId]/tables/[tId]/rows/index.ts
@@ -267,7 +267,8 @@ async function handler(
           status_code: 400,
           api_error: {
             type: "invalid_request_error",
-            message: `Invalid request body: ${r.error.message}`,
+            message: "Invalid request body.",
+            request_format_errors: r.error.flatten(),
           },
         });
       }

diff --git a/front/pages/api/v1/w/[wId]/spaces/[spaceId]/data_sources/[dsId]/tables/csv.ts b/front/pages/api/v1/w/[wId]/spaces/[spaceId]/data_sources/[dsId]/tables/csv.ts
@@ -108,7 +108,8 @@ async function handler(
           status_code: 400,
           api_error: {
             type: "invalid_request_error",
-            message: `Invalid request body: ${r.error.message}`,
+            message: "Invalid request body.",
+            request_format_errors: r.error.flatten(),
           },
         });
       }

diff --git a/front/pages/api/v1/w/[wId]/spaces/[spaceId]/data_sources/[dsId]/tables/index.ts b/front/pages/api/v1/w/[wId]/spaces/[spaceId]/data_sources/[dsId]/tables/index.ts
@@ -243,7 +243,8 @@ async function handler(
           status_code: 400,
           api_error: {
             type: "invalid_request_error",
-            message: `Invalid request body: ${r.error.message}`,
+            message: "Invalid request body.",
+            request_format_errors: r.error.flatten(),
           },
         });
       }

diff --git a/front/pages/api/v1/w/[wId]/swagger_schemas.ts b/front/pages/api/v1/w/[wId]/swagger_schemas.ts
@@ -96,10 +96,6 @@
  *       required:
  *         - username
  *         - timezone
- *         - fullName
- *         - email
- *         - profilePictureUrl
- *         - origin
  *       properties:
  *         username:
  *           type: string

diff --git a/front/pages/api/v1/w/[wId]/workspace-usage.ts b/front/pages/api/v1/w/[wId]/workspace-usage.ts
@@ -116,7 +116,8 @@ async function handler(
           status_code: 400,
           api_error: {
             type: "invalid_request_error",
-            message: `Invalid request body: ${r.error.message}`,
+            message: "Invalid request body.",
+            request_format_errors: r.error.flatten(),
           },
         });
       }

diff --git a/front/pages/api/w/[wId]/data_sources/[dsId]/search.ts b/front/pages/api/w/[wId]/data_sources/[dsId]/search.ts
@@ -54,7 +54,8 @@ async function handler(
           status_code: 400,
           api_error: {
             type: "invalid_request_error",
-            message: `Invalid request body: ${r.error.message}`,
+            message: "Invalid request body.",
+            request_format_errors: r.error.flatten(),
           },
         });
       }

diff --git a/front/public/swagger.json b/front/public/swagger.json
@@ -49,6 +49,21 @@
                 "favorites"
               ]
             }
+          },
+          {
+            "in": "query",
+            "name": "includes",
+            "required": false,
+            "description": "Array of additional data to include in the response",
+            "schema": {
+              "type": "array",
+              "items": {
+                "type": "string",
+                "enum": [
+                  "authors"
+                ]
+              }
+            }
           }
         ],
         "security": [
@@ -3133,17 +3148,12 @@
                 "properties": {
                   "name": {
                     "type": "string",
-                    "description": "Name of the table",
-                    "deprecated": true
+                    "description": "Name of the table"
                   },
                   "title": {
                     "type": "string",
                     "description": "Title of the table"
                   },
-                  "mime_type": {
-                    "type": "string",
-                    "description": "Mime type of the table"
-                  },
                   "table_id": {
                     "type": "string",
                     "description": "Unique identifier for the table"
@@ -3547,11 +3557,7 @@
         "type": "object",
         "required": [
           "username",
-          "timezone",
-          "fullName",
-          "email",
-          "profilePictureUrl",
-          "origin"
+          "timezone"
         ],
         "properties": {
           "username": {

diff --git a/sdks/js/src/types.ts b/sdks/js/src/types.ts
@@ -1661,8 +1661,11 @@ export type PublicPostContentFragmentRequestBody = z.infer<
 
 export const PublicPostConversationsRequestBodySchema = z.intersection(
   z.object({
-    title: z.string().nullable(),
-    visibility: z.enum(["unlisted", "workspace", "deleted", "test"]),
+    title: z.string().nullable().optional(),
+    visibility: z
+      .enum(["unlisted", "workspace", "deleted", "test"])
+      .optional()
+      .default("unlisted"),
     message: z.union([
       z.intersection(
         z.object({

diff --git a/types/src/front/lib/error.ts b/types/src/front/lib/error.ts
@@ -107,6 +107,7 @@ export type APIErrorType =
 export type APIError = {
   type: APIErrorType;
   message: string;
+  request_format_errors?: object;
   data_source_error?: CoreAPIError;
   run_error?: CoreAPIError;
   app_error?: CoreAPIError;