From 17abbe97e501937b36e3094bd860598adcd5e421 Mon Sep 17 00:00:00 2001
From: timothycarambat <rambat1010@gmail.com>
Date: Tue, 20 Aug 2024 12:48:08 -0700
Subject: [PATCH] remove `#swagger.path` from API docs

---
 server/endpoints/api/admin/index.js           | 5 -----
 server/endpoints/api/workspace/index.js       | 6 ------
 server/endpoints/api/workspaceThread/index.js | 1 -
 server/swagger/openapi.json                   | 2 +-
 4 files changed, 1 insertion(+), 13 deletions(-)

diff --git a/server/endpoints/api/admin/index.js b/server/endpoints/api/admin/index.js
index d60a0f26a..e1eb05450 100644
--- a/server/endpoints/api/admin/index.js
+++ b/server/endpoints/api/admin/index.js
@@ -143,7 +143,6 @@ function apiAdminEndpoints(app) {
   app.post("/v1/admin/users/:id", [validApiKey], async (request, response) => {
     /*
     #swagger.tags = ['Admin']
-    #swagger.path = '/v1/admin/users/{id}'
     #swagger.parameters['id'] = {
       in: 'path',
       description: 'id of the user in the database.',
@@ -221,7 +220,6 @@ function apiAdminEndpoints(app) {
       /*
     #swagger.tags = ['Admin']
     #swagger.description = 'Delete existing user by id. Methods are disabled until multi user mode is enabled via the UI.'
-    #swagger.path = '/v1/admin/users/{id}'
     #swagger.parameters['id'] = {
       in: 'path',
       description: 'id of the user in the database.',
@@ -382,7 +380,6 @@ function apiAdminEndpoints(app) {
       /*
     #swagger.tags = ['Admin']
     #swagger.description = 'Deactivates (soft-delete) invite by id. Methods are disabled until multi user mode is enabled via the UI.'
-    #swagger.path = '/v1/admin/invite/{id}'
     #swagger.parameters['id'] = {
       in: 'path',
       description: 'id of the invite in the database.',
@@ -432,7 +429,6 @@ function apiAdminEndpoints(app) {
     async (request, response) => {
       /*
       #swagger.tags = ['Admin']
-      #swagger.path = '/v1/admin/workspaces/{workspaceId}/users'
       #swagger.parameters['workspaceId'] = {
         in: 'path',
         description: 'id of the workspace.',
@@ -487,7 +483,6 @@ function apiAdminEndpoints(app) {
     async (request, response) => {
       /*
     #swagger.tags = ['Admin']
-    #swagger.path = '/v1/admin/workspaces/{workspaceId}/update-users'
     #swagger.parameters['workspaceId'] = {
       in: 'path',
       description: 'id of the workspace in the database.',
diff --git a/server/endpoints/api/workspace/index.js b/server/endpoints/api/workspace/index.js
index 3d4e90fb4..c9a6cb51e 100644
--- a/server/endpoints/api/workspace/index.js
+++ b/server/endpoints/api/workspace/index.js
@@ -142,7 +142,6 @@ function apiWorkspaceEndpoints(app) {
     /*
     #swagger.tags = ['Workspaces']
     #swagger.description = 'Get a workspace by its unique slug.'
-    #swagger.path = '/v1/workspace/{slug}'
     #swagger.parameters['slug'] = {
         in: 'path',
         description: 'Unique slug of workspace to find',
@@ -209,7 +208,6 @@ function apiWorkspaceEndpoints(app) {
       /*
     #swagger.tags = ['Workspaces']
     #swagger.description = 'Deletes a workspace by its slug.'
-    #swagger.path = '/v1/workspace/{slug}'
     #swagger.parameters['slug'] = {
         in: 'path',
         description: 'Unique slug of workspace to delete',
@@ -261,7 +259,6 @@ function apiWorkspaceEndpoints(app) {
       /*
     #swagger.tags = ['Workspaces']
     #swagger.description = 'Update workspace settings by its unique slug.'
-    #swagger.path = '/v1/workspace/{slug}/update'
     #swagger.parameters['slug'] = {
         in: 'path',
         description: 'Unique slug of workspace to find',
@@ -341,7 +338,6 @@ function apiWorkspaceEndpoints(app) {
       /*
     #swagger.tags = ['Workspaces']
     #swagger.description = 'Get a workspaces chats regardless of user by its unique slug.'
-    #swagger.path = '/v1/workspace/{slug}/chats'
     #swagger.parameters['slug'] = {
         in: 'path',
         description: 'Unique slug of workspace to find',
@@ -402,7 +398,6 @@ function apiWorkspaceEndpoints(app) {
       /*
     #swagger.tags = ['Workspaces']
     #swagger.description = 'Add or remove documents from a workspace by its unique slug.'
-    #swagger.path = '/v1/workspace/{slug}/update-embeddings'
     #swagger.parameters['slug'] = {
         in: 'path',
         description: 'Unique slug of workspace to find',
@@ -481,7 +476,6 @@ function apiWorkspaceEndpoints(app) {
       /*
       #swagger.tags = ['Workspaces']
       #swagger.description = 'Add or remove pin from a document in a workspace by its unique slug.'
-      #swagger.path = '/workspace/{slug}/update-pin'
       #swagger.parameters['slug'] = {
           in: 'path',
           description: 'Unique slug of workspace to find',
diff --git a/server/endpoints/api/workspaceThread/index.js b/server/endpoints/api/workspaceThread/index.js
index e2c6af1c7..de30e24d0 100644
--- a/server/endpoints/api/workspaceThread/index.js
+++ b/server/endpoints/api/workspaceThread/index.js
@@ -110,7 +110,6 @@ function apiWorkspaceThreadEndpoints(app) {
       /*
       #swagger.tags = ['Workspace Threads']
       #swagger.description = 'Update thread name by its unique slug.'
-      #swagger.path = '/v1/workspace/{slug}/thread/{threadSlug}/update'
       #swagger.parameters['slug'] = {
           in: 'path',
           description: 'Unique slug of workspace',
diff --git a/server/swagger/openapi.json b/server/swagger/openapi.json
index e14ed576f..ef4144922 100644
--- a/server/swagger/openapi.json
+++ b/server/swagger/openapi.json
@@ -1846,7 +1846,7 @@
         }
       }
     },
-    "/workspace/{slug}/update-pin": {
+    "/v1/workspace/{slug}/update-pin": {
       "post": {
         "tags": [
           "Workspaces"