patch response body for swagger

Mintplex-Labs · Jul 22, 2024 · d0713e1 · d0713e1
1 parent 76aa2a4
commit d0713e1
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 2 deletions.
diff --git a/server/endpoints/api/document/index.js b/server/endpoints/api/document/index.js
@@ -237,7 +237,7 @@ function apiDocumentEndpoints(app) {
             example: {
               "textContent": "This is the raw text that will be saved as a document in AnythingLLM.",
               "metadata": {
-                "title": "This key is required. See in /server/endpoints/api/document/index.js:287"
+                "title": "This key is required. See in /server/endpoints/api/document/index.js:287",
                 keyOne: "valueOne",
                 keyTwo: "valueTwo",
                 etc: "etc"

diff --git a/server/swagger/openapi.json b/server/swagger/openapi.json
@@ -1012,7 +1012,27 @@
             "description": "Internal Server Error"
           }
         },
-        "requestBody": {}
+        "requestBody": {
+          "description": "Text content and metadata of the file to be saved to the system. Use metadata-schema endpoint to get the possible metadata keys",
+          "required": true,
+          "type": "object",
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "example": {
+                  "textContent": "This is the raw text that will be saved as a document in AnythingLLM.",
+                  "metadata": {
+                    "title": "This key is required. See in /server/endpoints/api/document/index.js:287",
+                    "keyOne": "valueOne",
+                    "keyTwo": "valueTwo",
+                    "etc": "etc"
+                  }
+                }
+              }
+            }
+          }
+        }
       }
     },
     "/v1/documents": {