Feature/update api example outputs (#2547)

* /v1/workspace/{slug} actually returns an array - update example output * update swagger example to show array output
Mintplex-Labs · Oct 29, 2024 · ccde891 · ccde891
1 parent 4eeac27
commit ccde891
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 24 deletions.
diff --git a/server/endpoints/api/workspace/index.js b/server/endpoints/api/workspace/index.js
@@ -150,18 +150,20 @@ function apiWorkspaceEndpoints(app) {
           schema: {
             type: 'object',
             example: {
-              workspace: {
-                "id": 79,
-                "name": "My workspace",
-                "slug": "my-workspace-123",
-                "createdAt": "2023-08-17 00:45:03",
-                "openAiTemp": null,
-                "lastUpdatedAt": "2023-08-17 00:45:03",
-                "openAiHistory": 20,
-                "openAiPrompt": null,
-                "documents": [],
-                "threads": []
-              }
+              workspace: [
+                {
+                  "id": 79,
+                  "name": "My workspace",
+                  "slug": "my-workspace-123",
+                  "createdAt": "2023-08-17 00:45:03",
+                  "openAiTemp": null,
+                  "lastUpdatedAt": "2023-08-17 00:45:03",
+                  "openAiHistory": 20,
+                  "openAiPrompt": null,
+                  "documents": [],
+                  "threads": []
+                }
+              ]
             }
           }
         }

diff --git a/server/swagger/openapi.json b/server/swagger/openapi.json
@@ -1473,18 +1473,20 @@
                 "schema": {
                   "type": "object",
                   "example": {
-                    "workspace": {
-                      "id": 79,
-                      "name": "My workspace",
-                      "slug": "my-workspace-123",
-                      "createdAt": "2023-08-17 00:45:03",
-                      "openAiTemp": null,
-                      "lastUpdatedAt": "2023-08-17 00:45:03",
-                      "openAiHistory": 20,
-                      "openAiPrompt": null,
-                      "documents": [],
-                      "threads": []
-                    }
+                    "workspace": [
+                      {
+                        "id": 79,
+                        "name": "My workspace",
+                        "slug": "my-workspace-123",
+                        "createdAt": "2023-08-17 00:45:03",
+                        "openAiTemp": null,
+                        "lastUpdatedAt": "2023-08-17 00:45:03",
+                        "openAiHistory": 20,
+                        "openAiPrompt": null,
+                        "documents": [],
+                        "threads": []
+                      }
+                    ]
                   }
                 }
               }