sij/anything-llm
1
0
Fork 0
mirror of https://github.com/Mintplex-Labs/anything-llm.git synced 2025-04-23 13:08:11 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions1

Fix Swagger docs ()

Browse source
This commit is contained in:
Timothy Carambat 2024-05-21 21:30:37 -05:00 • committed by GitHub
parent b23cb1a90f
commit 196c4c13c4
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 48 additions and 299 deletions

6
server/swagger/index.js
View file

@ -19,10 +19,10 @@ function waitForElm(selector) {
} }
// Force change the Swagger logo in the header // Force change the Swagger logo in the header
waitForElm('img[alt="Swagger UI"]').then((elm) => { waitForElm('.topbar-wrapper').then((elm) => {
if (window.SWAGGER_DOCS_ENV === 'development') { if (window.SWAGGER_DOCS_ENV === 'development') {
elm.src = 'http://localhost:3000/public/anything-llm.png' elm.innerHTML = `<img href='${window.location.origin}' src='http://localhost:3000/public/anything-llm-light.png' width='200'/>`
} else { } else {
elm.src = `${window.location.origin}/anything-llm.png` elm.innerHTML = `<img href='${window.location.origin}' src='${window.location.origin}/anything-llm-light.png' width='200'/>`
} }
}); });

22
server/swagger/init.js
View file

@ -40,6 +40,28 @@ const endpointsFiles = [
swaggerAutogen(outputFile, endpointsFiles, doc) swaggerAutogen(outputFile, endpointsFiles, doc)
.then(({ data }) => { .then(({ data }) => {
// Remove Authorization parameters from arguments.
for (const path of Object.keys(data.paths)) {
if (data.paths[path].hasOwnProperty('get')) {
let parameters = data.paths[path].get?.parameters || [];
parameters = parameters.filter((arg) => arg.name !== 'Authorization');
data.paths[path].get.parameters = parameters;
}
if (data.paths[path].hasOwnProperty('post')) {
let parameters = data.paths[path].post?.parameters || [];
parameters = parameters.filter((arg) => arg.name !== 'Authorization');
data.paths[path].post.parameters = parameters;
}
if (data.paths[path].hasOwnProperty('delete')) {
let parameters = data.paths[path].delete?.parameters || [];
parameters = parameters.filter((arg) => arg.name !== 'Authorization');
data.paths[path].delete.parameters = parameters;
}
}
const openApiSpec = { const openApiSpec = {
...data, ...data,
servers: [{ servers: [{

319
server/swagger/openapi.json
View file

@ -17,15 +17,7 @@
"Authentication" "Authentication"
], ],
"description": "Verify the attached Authentication header contains a valid API token.", "description": "Verify the attached Authentication header contains a valid API token.",
"parameters": [ "parameters": [],
{
"name": "Authorization",
"in": "header",
"schema": {
"type": "string"
}
}
],
"responses": { "responses": {
"200": { "200": {
"description": "Valid auth token was found.", "description": "Valid auth token was found.",
@ -64,15 +56,7 @@
"Admin" "Admin"
], ],
"description": "Check to see if the instance is in multi-user-mode first. Methods are disabled until multi user mode is enabled via the UI.", "description": "Check to see if the instance is in multi-user-mode first. Methods are disabled until multi user mode is enabled via the UI.",
"parameters": [ "parameters": [],
{
"name": "Authorization",
"in": "header",
"schema": {
"type": "string"
}
}
],
"responses": { "responses": {
"200": { "200": {
"description": "OK", "description": "OK",
@ -111,15 +95,7 @@
"Admin" "Admin"
], ],
"description": "Check to see if the instance is in multi-user-mode first. Methods are disabled until multi user mode is enabled via the UI.", "description": "Check to see if the instance is in multi-user-mode first. Methods are disabled until multi user mode is enabled via the UI.",
"parameters": [ "parameters": [],
{
"name": "Authorization",
"in": "header",
"schema": {
"type": "string"
}
}
],
"responses": { "responses": {
"200": { "200": {
"description": "OK", "description": "OK",
@ -169,15 +145,7 @@
"Admin" "Admin"
], ],
"description": "Create a new user with username and password. Methods are disabled until multi user mode is enabled via the UI.", "description": "Create a new user with username and password. Methods are disabled until multi user mode is enabled via the UI.",
"parameters": [ "parameters": [],
{
"name": "Authorization",
"in": "header",
"schema": {
"type": "string"
}
}
],
"responses": { "responses": {
"200": { "200": {
"description": "OK", "description": "OK",
@ -250,13 +218,6 @@
"type": "string" "type": "string"
}, },
"description": "id of the user in the database." "description": "id of the user in the database."
},
{
"name": "Authorization",
"in": "header",
"schema": {
"type": "string"
}
} }
], ],
"responses": { "responses": {
@ -326,13 +287,6 @@
"type": "string" "type": "string"
}, },
"description": "id of the user in the database." "description": "id of the user in the database."
},
{
"name": "Authorization",
"in": "header",
"schema": {
"type": "string"
}
} }
], ],
"responses": { "responses": {
@ -380,15 +334,7 @@
"Admin" "Admin"
], ],
"description": "List all existing invitations to instance regardless of status. Methods are disabled until multi user mode is enabled via the UI.", "description": "List all existing invitations to instance regardless of status. Methods are disabled until multi user mode is enabled via the UI.",
"parameters": [ "parameters": [],
{
"name": "Authorization",
"in": "header",
"schema": {
"type": "string"
}
}
],
"responses": { "responses": {
"200": { "200": {
"description": "OK", "description": "OK",
@ -440,15 +386,7 @@
"Admin" "Admin"
], ],
"description": "Create a new invite code for someone to use to register with instance. Methods are disabled until multi user mode is enabled via the UI.", "description": "Create a new invite code for someone to use to register with instance. Methods are disabled until multi user mode is enabled via the UI.",
"parameters": [ "parameters": [],
{
"name": "Authorization",
"in": "header",
"schema": {
"type": "string"
}
}
],
"responses": { "responses": {
"200": { "200": {
"description": "OK", "description": "OK",
@ -523,13 +461,6 @@
"type": "string" "type": "string"
}, },
"description": "id of the invite in the database." "description": "id of the invite in the database."
},
{
"name": "Authorization",
"in": "header",
"schema": {
"type": "string"
}
} }
], ],
"responses": { "responses": {
@ -586,13 +517,6 @@
"type": "string" "type": "string"
}, },
"description": "id of the workspace in the database." "description": "id of the workspace in the database."
},
{
"name": "Authorization",
"in": "header",
"schema": {
"type": "string"
}
} }
], ],
"responses": { "responses": {
@ -657,15 +581,7 @@
"Admin" "Admin"
], ],
"description": "All chats in the system ordered by most recent. Methods are disabled until multi user mode is enabled via the UI.", "description": "All chats in the system ordered by most recent. Methods are disabled until multi user mode is enabled via the UI.",
"parameters": [ "parameters": [],
{
"name": "Authorization",
"in": "header",
"schema": {
"type": "string"
}
}
],
"responses": { "responses": {
"200": { "200": {
"description": "OK", "description": "OK",
@ -720,15 +636,7 @@
"Admin" "Admin"
], ],
"description": "Show all multi-user preferences for instance. Methods are disabled until multi user mode is enabled via the UI.", "description": "Show all multi-user preferences for instance. Methods are disabled until multi user mode is enabled via the UI.",
"parameters": [ "parameters": [],
{
"name": "Authorization",
"in": "header",
"schema": {
"type": "string"
}
}
],
"responses": { "responses": {
"200": { "200": {
"description": "OK", "description": "OK",
@ -775,15 +683,7 @@
"Admin" "Admin"
], ],
"description": "Update multi-user preferences for instance. Methods are disabled until multi user mode is enabled via the UI.", "description": "Update multi-user preferences for instance. Methods are disabled until multi user mode is enabled via the UI.",
"parameters": [ "parameters": [],
{
"name": "Authorization",
"in": "header",
"schema": {
"type": "string"
}
}
],
"responses": { "responses": {
"200": { "200": {
"description": "OK", "description": "OK",
@ -843,15 +743,7 @@
"Documents" "Documents"
], ],
"description": "Upload a new file to AnythingLLM to be parsed and prepared for embedding.", "description": "Upload a new file to AnythingLLM to be parsed and prepared for embedding.",
"parameters": [ "parameters": [],
{
"name": "Authorization",
"in": "header",
"schema": {
"type": "string"
}
}
],
"responses": { "responses": {
"200": { "200": {
"description": "OK", "description": "OK",
@ -927,15 +819,7 @@
"Documents" "Documents"
], ],
"description": "Upload a valid URL for AnythingLLM to scrape and prepare for embedding.", "description": "Upload a valid URL for AnythingLLM to scrape and prepare for embedding.",
"parameters": [ "parameters": [],
{
"name": "Authorization",
"in": "header",
"schema": {
"type": "string"
}
}
],
"responses": { "responses": {
"200": { "200": {
"description": "OK", "description": "OK",
@ -1009,15 +893,7 @@
"Documents" "Documents"
], ],
"description": "Upload a file by specifying its raw text content and metadata values without having to upload a file.", "description": "Upload a file by specifying its raw text content and metadata values without having to upload a file.",
"parameters": [ "parameters": [],
{
"name": "Authorization",
"in": "header",
"schema": {
"type": "string"
}
}
],
"responses": { "responses": {
"200": { "200": {
"description": "OK", "description": "OK",
@ -1099,15 +975,7 @@
"Documents" "Documents"
], ],
"description": "List of all locally-stored documents in instance", "description": "List of all locally-stored documents in instance",
"parameters": [ "parameters": [],
{
"name": "Authorization",
"in": "header",
"schema": {
"type": "string"
}
}
],
"responses": { "responses": {
"200": { "200": {
"description": "OK", "description": "OK",
@ -1162,15 +1030,7 @@
"Documents" "Documents"
], ],
"description": "Check available filetypes and MIMEs that can be uploaded.", "description": "Check available filetypes and MIMEs that can be uploaded.",
"parameters": [ "parameters": [],
{
"name": "Authorization",
"in": "header",
"schema": {
"type": "string"
}
}
],
"responses": { "responses": {
"200": { "200": {
"description": "OK", "description": "OK",
@ -1232,15 +1092,7 @@
"Documents" "Documents"
], ],
"description": "Get the known available metadata schema for when doing a raw-text upload and the acceptable type of value for each key.", "description": "Get the known available metadata schema for when doing a raw-text upload and the acceptable type of value for each key.",
"parameters": [ "parameters": [],
{
"name": "Authorization",
"in": "header",
"schema": {
"type": "string"
}
}
],
"responses": { "responses": {
"200": { "200": {
"description": "OK", "description": "OK",
@ -1296,13 +1148,6 @@
"type": "string" "type": "string"
}, },
"description": "Unique document name to find (name in /documents)" "description": "Unique document name to find (name in /documents)"
},
{
"name": "Authorization",
"in": "header",
"schema": {
"type": "string"
}
} }
], ],
"responses": { "responses": {
@ -1362,15 +1207,7 @@
"Documents" "Documents"
], ],
"description": "Create a new folder inside the documents storage directory.", "description": "Create a new folder inside the documents storage directory.",
"parameters": [ "parameters": [],
{
"name": "Authorization",
"in": "header",
"schema": {
"type": "string"
}
}
],
"responses": { "responses": {
"200": { "200": {
"description": "OK", "description": "OK",
@ -1428,15 +1265,7 @@
"Documents" "Documents"
], ],
"description": "Move files within the documents storage directory.", "description": "Move files within the documents storage directory.",
"parameters": [ "parameters": [],
{
"name": "Authorization",
"in": "header",
"schema": {
"type": "string"
}
}
],
"responses": { "responses": {
"200": { "200": {
"description": "OK", "description": "OK",
@ -1499,15 +1328,7 @@
"Workspaces" "Workspaces"
], ],
"description": "Create a new workspace", "description": "Create a new workspace",
"parameters": [ "parameters": [],
{
"name": "Authorization",
"in": "header",
"schema": {
"type": "string"
}
}
],
"responses": { "responses": {
"200": { "200": {
"description": "OK", "description": "OK",
@ -1571,15 +1392,7 @@
"Workspaces" "Workspaces"
], ],
"description": "List all current workspaces", "description": "List all current workspaces",
"parameters": [ "parameters": [],
{
"name": "Authorization",
"in": "header",
"schema": {
"type": "string"
}
}
],
"responses": { "responses": {
"200": { "200": {
"description": "OK", "description": "OK",
@ -1641,13 +1454,6 @@
"type": "string" "type": "string"
}, },
"description": "Unique slug of workspace to find" "description": "Unique slug of workspace to find"
},
{
"name": "Authorization",
"in": "header",
"schema": {
"type": "string"
}
} }
], ],
"responses": { "responses": {
@ -1708,13 +1514,6 @@
"type": "string" "type": "string"
}, },
"description": "Unique slug of workspace to delete" "description": "Unique slug of workspace to delete"
},
{
"name": "Authorization",
"in": "header",
"schema": {
"type": "string"
}
} }
], ],
"responses": { "responses": {
@ -1760,13 +1559,6 @@
"type": "string" "type": "string"
}, },
"description": "Unique slug of workspace to find" "description": "Unique slug of workspace to find"
},
{
"name": "Authorization",
"in": "header",
"schema": {
"type": "string"
}
} }
], ],
"responses": { "responses": {
@ -1848,13 +1640,6 @@
"type": "string" "type": "string"
}, },
"description": "Unique slug of workspace to find" "description": "Unique slug of workspace to find"
},
{
"name": "Authorization",
"in": "header",
"schema": {
"type": "string"
}
} }
], ],
"responses": { "responses": {
@ -1925,13 +1710,6 @@
"type": "string" "type": "string"
}, },
"description": "Unique slug of workspace to find" "description": "Unique slug of workspace to find"
},
{
"name": "Authorization",
"in": "header",
"schema": {
"type": "string"
}
} }
], ],
"responses": { "responses": {
@ -2015,13 +1793,6 @@
"type": "string" "type": "string"
}, },
"description": "Unique slug of workspace to find" "description": "Unique slug of workspace to find"
},
{
"name": "Authorization",
"in": "header",
"schema": {
"type": "string"
}
} }
], ],
"responses": { "responses": {
@ -2077,13 +1848,6 @@
"schema": { "schema": {
"type": "string" "type": "string"
} }
},
{
"name": "Authorization",
"in": "header",
"schema": {
"type": "string"
}
} }
], ],
"responses": { "responses": {
@ -2161,13 +1925,6 @@
"schema": { "schema": {
"type": "string" "type": "string"
} }
},
{
"name": "Authorization",
"in": "header",
"schema": {
"type": "string"
}
} }
], ],
"responses": { "responses": {
@ -2252,6 +2009,7 @@
"System Settings" "System Settings"
], ],
"description": "Dump all settings to file storage", "description": "Dump all settings to file storage",
"parameters": [],
"responses": { "responses": {
"200": { "200": {
"description": "OK" "description": "OK"
@ -2283,15 +2041,7 @@
"System Settings" "System Settings"
], ],
"description": "Get all current system settings that are defined.", "description": "Get all current system settings that are defined.",
"parameters": [ "parameters": [],
{
"name": "Authorization",
"in": "header",
"schema": {
"type": "string"
}
}
],
"responses": { "responses": {
"200": { "200": {
"description": "OK", "description": "OK",
@ -2339,15 +2089,7 @@
"System Settings" "System Settings"
], ],
"description": "Number of all vectors in connected vector database", "description": "Number of all vectors in connected vector database",
"parameters": [ "parameters": [],
{
"name": "Authorization",
"in": "header",
"schema": {
"type": "string"
}
}
],
"responses": { "responses": {
"200": { "200": {
"description": "OK", "description": "OK",
@ -2389,15 +2131,7 @@
"System Settings" "System Settings"
], ],
"description": "Update a system setting or preference.", "description": "Update a system setting or preference.",
"parameters": [ "parameters": [],
{
"name": "Authorization",
"in": "header",
"schema": {
"type": "string"
}
}
],
"responses": { "responses": {
"200": { "200": {
"description": "OK", "description": "OK",
@ -2456,13 +2190,6 @@
], ],
"description": "Export all of the chats from the system in a known format. Output depends on the type sent. Will be send with the correct header for the output.", "description": "Export all of the chats from the system in a known format. Output depends on the type sent. Will be send with the correct header for the output.",
"parameters": [ "parameters": [
{
"name": "Authorization",
"in": "header",
"schema": {
"type": "string"
}
},
{ {
"name": "type", "name": "type",
"in": "query", "in": "query",