diff --git a/server/swagger/openapi.json b/server/swagger/openapi.json index 5fcfdee5b..ebfadd001 100644 --- a/server/swagger/openapi.json +++ b/server/swagger/openapi.json @@ -7,7 +7,7 @@ }, "servers": [ { - "url": "http:///api/" + "url": "/api" } ], "paths": { @@ -17,15 +17,7 @@ "Authentication" ], "description": "Verify the attached Authentication header contains a valid API token.", - "parameters": [ - { - "name": "Authorization", - "in": "header", - "schema": { - "type": "string" - } - } - ], + "parameters": [], "responses": { "200": { "description": "Valid auth token was found.", @@ -64,15 +56,7 @@ "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.", - "parameters": [ - { - "name": "Authorization", - "in": "header", - "schema": { - "type": "string" - } - } - ], + "parameters": [], "responses": { "200": { "description": "OK", @@ -111,15 +95,7 @@ "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.", - "parameters": [ - { - "name": "Authorization", - "in": "header", - "schema": { - "type": "string" - } - } - ], + "parameters": [], "responses": { "200": { "description": "OK", @@ -169,15 +145,7 @@ "Admin" ], "description": "Create a new user with username and password. Methods are disabled until multi user mode is enabled via the UI.", - "parameters": [ - { - "name": "Authorization", - "in": "header", - "schema": { - "type": "string" - } - } - ], + "parameters": [], "responses": { "200": { "description": "OK", @@ -252,13 +220,6 @@ "type": "string" }, "description": "id of the user in the database." - }, - { - "name": "Authorization", - "in": "header", - "schema": { - "type": "string" - } } ], "responses": { @@ -327,13 +288,6 @@ "type": "string" }, "description": "id of the user in the database." - }, - { - "name": "Authorization", - "in": "header", - "schema": { - "type": "string" - } } ], "responses": { @@ -381,15 +335,7 @@ "Admin" ], "description": "List all existing invitations to instance regardless of status. Methods are disabled until multi user mode is enabled via the UI.", - "parameters": [ - { - "name": "Authorization", - "in": "header", - "schema": { - "type": "string" - } - } - ], + "parameters": [], "responses": { "200": { "description": "OK", @@ -441,15 +387,7 @@ "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.", - "parameters": [ - { - "name": "Authorization", - "in": "header", - "schema": { - "type": "string" - } - } - ], + "parameters": [], "responses": { "200": { "description": "OK", @@ -523,13 +461,6 @@ "type": "string" }, "description": "id of the invite in the database." - }, - { - "name": "Authorization", - "in": "header", - "schema": { - "type": "string" - } } ], "responses": { @@ -586,13 +517,6 @@ "type": "string" }, "description": "id of the workspace." - }, - { - "name": "Authorization", - "in": "header", - "schema": { - "type": "string" - } } ], "responses": { @@ -657,13 +581,6 @@ "type": "string" }, "description": "id of the workspace in the database." - }, - { - "name": "Authorization", - "in": "header", - "schema": { - "type": "string" - } } ], "responses": { @@ -737,13 +654,6 @@ "type": "string" }, "description": "slug of the workspace in the database" - }, - { - "name": "Authorization", - "in": "header", - "schema": { - "type": "string" - } } ], "responses": { @@ -823,15 +733,7 @@ "Admin" ], "description": "All chats in the system ordered by most recent. Methods are disabled until multi user mode is enabled via the UI.", - "parameters": [ - { - "name": "Authorization", - "in": "header", - "schema": { - "type": "string" - } - } - ], + "parameters": [], "responses": { "200": { "description": "OK", @@ -885,15 +787,7 @@ "Admin" ], "description": "Update multi-user preferences for instance. Methods are disabled until multi user mode is enabled via the UI.", - "parameters": [ - { - "name": "Authorization", - "in": "header", - "schema": { - "type": "string" - } - } - ], + "parameters": [], "responses": { "200": { "description": "OK", @@ -950,15 +844,7 @@ "Documents" ], "description": "Upload a new file to AnythingLLM to be parsed and prepared for embedding, with optional metadata.", - "parameters": [ - { - "name": "Authorization", - "in": "header", - "schema": { - "type": "string" - } - } - ], + "parameters": [], "responses": { "200": { "description": "OK", @@ -1064,13 +950,6 @@ }, "description": "Target folder path (defaults to 'custom-documents' if not provided)", "example": "my-folder" - }, - { - "name": "Authorization", - "in": "header", - "schema": { - "type": "string" - } } ], "responses": { @@ -1179,15 +1058,7 @@ "Documents" ], "description": "Upload a valid URL for AnythingLLM to scrape and prepare for embedding. Optionally, specify a comma-separated list of workspace slugs to embed the document into post-upload.", - "parameters": [ - { - "name": "Authorization", - "in": "header", - "schema": { - "type": "string" - } - } - ], + "parameters": [], "responses": { "200": { "description": "OK", @@ -1274,15 +1145,7 @@ "Documents" ], "description": "Upload a file by specifying its raw text content and metadata values without having to upload a file.", - "parameters": [ - { - "name": "Authorization", - "in": "header", - "schema": { - "type": "string" - } - } - ], + "parameters": [], "responses": { "200": { "description": "OK", @@ -1365,15 +1228,7 @@ "Documents" ], "description": "List of all locally-stored documents in instance", - "parameters": [ - { - "name": "Authorization", - "in": "header", - "schema": { - "type": "string" - } - } - ], + "parameters": [], "responses": { "200": { "description": "OK", @@ -1437,13 +1292,6 @@ "type": "string" }, "description": "Name of the folder to retrieve documents from" - }, - { - "name": "Authorization", - "in": "header", - "schema": { - "type": "string" - } } ], "responses": { @@ -1505,15 +1353,7 @@ "Documents" ], "description": "Check available filetypes and MIMEs that can be uploaded.", - "parameters": [ - { - "name": "Authorization", - "in": "header", - "schema": { - "type": "string" - } - } - ], + "parameters": [], "responses": { "200": { "description": "OK", @@ -1575,15 +1415,7 @@ "Documents" ], "description": "Get the known available metadata schema for when doing a raw-text upload and the acceptable type of value for each key.", - "parameters": [ - { - "name": "Authorization", - "in": "header", - "schema": { - "type": "string" - } - } - ], + "parameters": [], "responses": { "200": { "description": "OK", @@ -1639,13 +1471,6 @@ "type": "string" }, "description": "Unique document name to find (name in /documents)" - }, - { - "name": "Authorization", - "in": "header", - "schema": { - "type": "string" - } } ], "responses": { @@ -1705,15 +1530,7 @@ "Documents" ], "description": "Create a new folder inside the documents storage directory.", - "parameters": [ - { - "name": "Authorization", - "in": "header", - "schema": { - "type": "string" - } - } - ], + "parameters": [], "responses": { "200": { "description": "OK", @@ -1770,15 +1587,7 @@ "Documents" ], "description": "Remove a folder and all its contents from the documents storage directory.", - "parameters": [ - { - "name": "Authorization", - "in": "header", - "schema": { - "type": "string" - } - } - ], + "parameters": [], "responses": { "200": { "description": "OK", @@ -1838,15 +1647,7 @@ "Documents" ], "description": "Move files within the documents storage directory.", - "parameters": [ - { - "name": "Authorization", - "in": "header", - "schema": { - "type": "string" - } - } - ], + "parameters": [], "responses": { "200": { "description": "OK", @@ -1908,15 +1709,7 @@ "Workspaces" ], "description": "Create a new workspace", - "parameters": [ - { - "name": "Authorization", - "in": "header", - "schema": { - "type": "string" - } - } - ], + "parameters": [], "responses": { "200": { "description": "OK", @@ -1989,15 +1782,7 @@ "Workspaces" ], "description": "List all current workspaces", - "parameters": [ - { - "name": "Authorization", - "in": "header", - "schema": { - "type": "string" - } - } - ], + "parameters": [], "responses": { "200": { "description": "OK", @@ -2060,13 +1845,6 @@ "type": "string" }, "description": "Unique slug of workspace to find" - }, - { - "name": "Authorization", - "in": "header", - "schema": { - "type": "string" - } } ], "responses": { @@ -2130,13 +1908,6 @@ "type": "string" }, "description": "Unique slug of workspace to delete" - }, - { - "name": "Authorization", - "in": "header", - "schema": { - "type": "string" - } } ], "responses": { @@ -2182,13 +1953,6 @@ "type": "string" }, "description": "Unique slug of workspace to find" - }, - { - "name": "Authorization", - "in": "header", - "schema": { - "type": "string" - } } ], "responses": { @@ -2270,13 +2034,6 @@ }, "description": "Unique slug of workspace to find" }, - { - "name": "Authorization", - "in": "header", - "schema": { - "type": "string" - } - }, { "name": "apiSessionId", "in": "query", @@ -2373,13 +2130,6 @@ "type": "string" }, "description": "Unique slug of workspace to find" - }, - { - "name": "Authorization", - "in": "header", - "schema": { - "type": "string" - } } ], "responses": { @@ -2462,13 +2212,6 @@ "type": "string" }, "description": "Unique slug of workspace to find" - }, - { - "name": "Authorization", - "in": "header", - "schema": { - "type": "string" - } } ], "responses": { @@ -2523,13 +2266,6 @@ "schema": { "type": "string" } - }, - { - "name": "Authorization", - "in": "header", - "schema": { - "type": "string" - } } ], "responses": { @@ -2620,13 +2356,6 @@ "schema": { "type": "string" } - }, - { - "name": "Authorization", - "in": "header", - "schema": { - "type": "string" - } } ], "responses": { @@ -2736,13 +2465,6 @@ "type": "string" }, "description": "Unique slug of workspace to search in" - }, - { - "name": "Authorization", - "in": "header", - "schema": { - "type": "string" - } } ], "responses": { @@ -2808,6 +2530,7 @@ "System Settings" ], "description": "Dump all settings to file storage", + "parameters": [], "responses": { "200": { "description": "OK" @@ -2839,15 +2562,7 @@ "System Settings" ], "description": "Get all current system settings that are defined.", - "parameters": [ - { - "name": "Authorization", - "in": "header", - "schema": { - "type": "string" - } - } - ], + "parameters": [], "responses": { "200": { "description": "OK", @@ -2895,15 +2610,7 @@ "System Settings" ], "description": "Number of all vectors in connected vector database", - "parameters": [ - { - "name": "Authorization", - "in": "header", - "schema": { - "type": "string" - } - } - ], + "parameters": [], "responses": { "200": { "description": "OK", @@ -2945,15 +2652,7 @@ "System Settings" ], "description": "Update a system setting or preference.", - "parameters": [ - { - "name": "Authorization", - "in": "header", - "schema": { - "type": "string" - } - } - ], + "parameters": [], "responses": { "200": { "description": "OK", @@ -3011,13 +2710,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.", "parameters": [ - { - "name": "Authorization", - "in": "header", - "schema": { - "type": "string" - } - }, { "name": "type", "in": "query", @@ -3076,15 +2768,7 @@ "System Settings" ], "description": "Permanently remove documents from the system.", - "parameters": [ - { - "name": "Authorization", - "in": "header", - "schema": { - "type": "string" - } - } - ], + "parameters": [], "responses": { "200": { "description": "Documents removed successfully.", @@ -3158,13 +2842,6 @@ "type": "string" }, "description": "Unique slug of workspace" - }, - { - "name": "Authorization", - "in": "header", - "schema": { - "type": "string" - } } ], "responses": { @@ -3249,13 +2926,6 @@ "type": "string" }, "description": "Unique slug of thread" - }, - { - "name": "Authorization", - "in": "header", - "schema": { - "type": "string" - } } ], "responses": { @@ -3338,13 +3008,6 @@ "type": "string" }, "description": "Unique slug of thread" - }, - { - "name": "Authorization", - "in": "header", - "schema": { - "type": "string" - } } ], "responses": { @@ -3399,13 +3062,6 @@ "type": "string" }, "description": "Unique slug of thread" - }, - { - "name": "Authorization", - "in": "header", - "schema": { - "type": "string" - } } ], "responses": { @@ -3485,13 +3141,6 @@ "type": "string" }, "description": "Unique slug of thread" - }, - { - "name": "Authorization", - "in": "header", - "schema": { - "type": "string" - } } ], "responses": { @@ -3587,13 +3236,6 @@ "type": "string" }, "description": "Unique slug of thread" - }, - { - "name": "Authorization", - "in": "header", - "schema": { - "type": "string" - } } ], "responses": { @@ -3694,15 +3336,7 @@ "User Management" ], "description": "List all users", - "parameters": [ - { - "name": "Authorization", - "in": "header", - "schema": { - "type": "string" - } - } - ], + "parameters": [], "responses": { "200": { "description": "OK", @@ -3767,13 +3401,6 @@ "type": "string" }, "description": "The ID of the user to issue a temporary auth token for" - }, - { - "name": "Authorization", - "in": "header", - "schema": { - "type": "string" - } } ], "responses": { @@ -3824,15 +3451,7 @@ "OpenAI Compatible Endpoints" ], "description": "Get all available \"models\" which are workspaces you can use for chatting.", - "parameters": [ - { - "name": "Authorization", - "in": "header", - "schema": { - "type": "string" - } - } - ], + "parameters": [], "responses": { "200": { "description": "OK", @@ -3888,15 +3507,7 @@ "OpenAI Compatible Endpoints" ], "description": "Execute a chat with a workspace with OpenAI compatibility. Supports streaming as well. Model must be a workspace slug from /models.", - "parameters": [ - { - "name": "Authorization", - "in": "header", - "schema": { - "type": "string" - } - } - ], + "parameters": [], "responses": { "200": { "description": "OK" @@ -3965,15 +3576,7 @@ "OpenAI Compatible Endpoints" ], "description": "Get the embeddings of any arbitrary text string. This will use the embedder provider set in the system. Please ensure the token length of each string fits within the context of your embedder model.", - "parameters": [ - { - "name": "Authorization", - "in": "header", - "schema": { - "type": "string" - } - } - ], + "parameters": [], "responses": { "200": { "description": "OK" @@ -4020,15 +3623,7 @@ "OpenAI Compatible Endpoints" ], "description": "List all the vector database collections connected to AnythingLLM. These are essentially workspaces but return their unique vector db identifier - this is the same as the workspace slug.", - "parameters": [ - { - "name": "Authorization", - "in": "header", - "schema": { - "type": "string" - } - } - ], + "parameters": [], "responses": { "200": { "description": "OK", @@ -4080,15 +3675,7 @@ "Embed" ], "description": "List all active embeds", - "parameters": [ - { - "name": "Authorization", - "in": "header", - "schema": { - "type": "string" - } - } - ], + "parameters": [], "responses": { "200": { "description": "OK", @@ -4164,13 +3751,6 @@ "type": "string" }, "description": "UUID of the embed" - }, - { - "name": "Authorization", - "in": "header", - "schema": { - "type": "string" - } } ], "responses": { @@ -4250,13 +3830,6 @@ "type": "string" }, "description": "UUID of the session" - }, - { - "name": "Authorization", - "in": "header", - "schema": { - "type": "string" - } } ], "responses": { @@ -4310,15 +3883,7 @@ "Embed" ], "description": "Create a new embed configuration", - "parameters": [ - { - "name": "Authorization", - "in": "header", - "schema": { - "type": "string" - } - } - ], + "parameters": [], "responses": { "200": { "description": "OK", @@ -4414,13 +3979,6 @@ "type": "string" }, "description": "UUID of the embed to update" - }, - { - "name": "Authorization", - "in": "header", - "schema": { - "type": "string" - } } ], "responses": { @@ -4498,13 +4056,6 @@ "type": "string" }, "description": "UUID of the embed to delete" - }, - { - "name": "Authorization", - "in": "header", - "schema": { - "type": "string" - } } ], "responses": {