patch response body for swagger

This commit is contained in:
timothycarambat 2024-07-22 15:21:32 -07:00
parent 76aa2a4fd4
commit d0713e15f1
2 changed files with 22 additions and 2 deletions
server
endpoints/api/document
swagger

View file

@ -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"

View file

@ -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": {