remove #swagger.path from API docs

This commit is contained in:
timothycarambat 2024-08-20 12:48:08 -07:00
parent cb7cb2d976
commit 17abbe97e5
4 changed files with 1 additions and 13 deletions

View File

@ -143,7 +143,6 @@ function apiAdminEndpoints(app) {
app.post("/v1/admin/users/:id", [validApiKey], async (request, response) => { app.post("/v1/admin/users/:id", [validApiKey], async (request, response) => {
/* /*
#swagger.tags = ['Admin'] #swagger.tags = ['Admin']
#swagger.path = '/v1/admin/users/{id}'
#swagger.parameters['id'] = { #swagger.parameters['id'] = {
in: 'path', in: 'path',
description: 'id of the user in the database.', description: 'id of the user in the database.',
@ -221,7 +220,6 @@ function apiAdminEndpoints(app) {
/* /*
#swagger.tags = ['Admin'] #swagger.tags = ['Admin']
#swagger.description = 'Delete existing user by id. Methods are disabled until multi user mode is enabled via the UI.' #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'] = { #swagger.parameters['id'] = {
in: 'path', in: 'path',
description: 'id of the user in the database.', description: 'id of the user in the database.',
@ -382,7 +380,6 @@ function apiAdminEndpoints(app) {
/* /*
#swagger.tags = ['Admin'] #swagger.tags = ['Admin']
#swagger.description = 'Deactivates (soft-delete) invite by id. Methods are disabled until multi user mode is enabled via the UI.' #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'] = { #swagger.parameters['id'] = {
in: 'path', in: 'path',
description: 'id of the invite in the database.', description: 'id of the invite in the database.',
@ -432,7 +429,6 @@ function apiAdminEndpoints(app) {
async (request, response) => { async (request, response) => {
/* /*
#swagger.tags = ['Admin'] #swagger.tags = ['Admin']
#swagger.path = '/v1/admin/workspaces/{workspaceId}/users'
#swagger.parameters['workspaceId'] = { #swagger.parameters['workspaceId'] = {
in: 'path', in: 'path',
description: 'id of the workspace.', description: 'id of the workspace.',
@ -487,7 +483,6 @@ function apiAdminEndpoints(app) {
async (request, response) => { async (request, response) => {
/* /*
#swagger.tags = ['Admin'] #swagger.tags = ['Admin']
#swagger.path = '/v1/admin/workspaces/{workspaceId}/update-users'
#swagger.parameters['workspaceId'] = { #swagger.parameters['workspaceId'] = {
in: 'path', in: 'path',
description: 'id of the workspace in the database.', description: 'id of the workspace in the database.',

View File

@ -142,7 +142,6 @@ function apiWorkspaceEndpoints(app) {
/* /*
#swagger.tags = ['Workspaces'] #swagger.tags = ['Workspaces']
#swagger.description = 'Get a workspace by its unique slug.' #swagger.description = 'Get a workspace by its unique slug.'
#swagger.path = '/v1/workspace/{slug}'
#swagger.parameters['slug'] = { #swagger.parameters['slug'] = {
in: 'path', in: 'path',
description: 'Unique slug of workspace to find', description: 'Unique slug of workspace to find',
@ -209,7 +208,6 @@ function apiWorkspaceEndpoints(app) {
/* /*
#swagger.tags = ['Workspaces'] #swagger.tags = ['Workspaces']
#swagger.description = 'Deletes a workspace by its slug.' #swagger.description = 'Deletes a workspace by its slug.'
#swagger.path = '/v1/workspace/{slug}'
#swagger.parameters['slug'] = { #swagger.parameters['slug'] = {
in: 'path', in: 'path',
description: 'Unique slug of workspace to delete', description: 'Unique slug of workspace to delete',
@ -261,7 +259,6 @@ function apiWorkspaceEndpoints(app) {
/* /*
#swagger.tags = ['Workspaces'] #swagger.tags = ['Workspaces']
#swagger.description = 'Update workspace settings by its unique slug.' #swagger.description = 'Update workspace settings by its unique slug.'
#swagger.path = '/v1/workspace/{slug}/update'
#swagger.parameters['slug'] = { #swagger.parameters['slug'] = {
in: 'path', in: 'path',
description: 'Unique slug of workspace to find', description: 'Unique slug of workspace to find',
@ -341,7 +338,6 @@ function apiWorkspaceEndpoints(app) {
/* /*
#swagger.tags = ['Workspaces'] #swagger.tags = ['Workspaces']
#swagger.description = 'Get a workspaces chats regardless of user by its unique slug.' #swagger.description = 'Get a workspaces chats regardless of user by its unique slug.'
#swagger.path = '/v1/workspace/{slug}/chats'
#swagger.parameters['slug'] = { #swagger.parameters['slug'] = {
in: 'path', in: 'path',
description: 'Unique slug of workspace to find', description: 'Unique slug of workspace to find',
@ -402,7 +398,6 @@ function apiWorkspaceEndpoints(app) {
/* /*
#swagger.tags = ['Workspaces'] #swagger.tags = ['Workspaces']
#swagger.description = 'Add or remove documents from a workspace by its unique slug.' #swagger.description = 'Add or remove documents from a workspace by its unique slug.'
#swagger.path = '/v1/workspace/{slug}/update-embeddings'
#swagger.parameters['slug'] = { #swagger.parameters['slug'] = {
in: 'path', in: 'path',
description: 'Unique slug of workspace to find', description: 'Unique slug of workspace to find',
@ -481,7 +476,6 @@ function apiWorkspaceEndpoints(app) {
/* /*
#swagger.tags = ['Workspaces'] #swagger.tags = ['Workspaces']
#swagger.description = 'Add or remove pin from a document in a workspace by its unique slug.' #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'] = { #swagger.parameters['slug'] = {
in: 'path', in: 'path',
description: 'Unique slug of workspace to find', description: 'Unique slug of workspace to find',

View File

@ -110,7 +110,6 @@ function apiWorkspaceThreadEndpoints(app) {
/* /*
#swagger.tags = ['Workspace Threads'] #swagger.tags = ['Workspace Threads']
#swagger.description = 'Update thread name by its unique slug.' #swagger.description = 'Update thread name by its unique slug.'
#swagger.path = '/v1/workspace/{slug}/thread/{threadSlug}/update'
#swagger.parameters['slug'] = { #swagger.parameters['slug'] = {
in: 'path', in: 'path',
description: 'Unique slug of workspace', description: 'Unique slug of workspace',

View File

@ -1846,7 +1846,7 @@
} }
} }
}, },
"/workspace/{slug}/update-pin": { "/v1/workspace/{slug}/update-pin": {
"post": { "post": {
"tags": [ "tags": [
"Workspaces" "Workspaces"