Skip to content

Commit d617553

Browse files
chore: fix typo in API docs (#3023)
* chore: fix typo in API docs * fix openapi Co-authored-by: Thomas Stadelmann <[email protected]>
1 parent 0aa0c68 commit d617553

File tree

3 files changed

+3
-3
lines changed

3 files changed

+3
-3
lines changed

docs/_src/api/openapi/openapi-1.6.1rc0.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -316,7 +316,7 @@
316316
"document"
317317
],
318318
"summary": "Get Documents",
319-
"description": "This endpoint allows you to retrieve documents contained in your document store.\nYou can filter the documents to delete by metadata (like the document's name),\nor provide an empty JSON object to clear the document store.\n\nExample of filters:\n`'{\"filters\": {{\"name\": [\"some\", \"more\"], \"category\": [\"only_one\"]}}'`\n\nTo get all documents you should provide an empty dict, like:\n`'{\"filters\": {}}'`",
319+
"description": "This endpoint allows you to retrieve documents contained in your document store.\nYou can filter the documents to retrieve by metadata (like the document's name),\nor provide an empty JSON object to clear the document store.\n\nExample of filters:\n`'{\"filters\": {{\"name\": [\"some\", \"more\"], \"category\": [\"only_one\"]}}'`\n\nTo get all documents you should provide an empty dict, like:\n`'{\"filters\": {}}'`",
320320
"operationId": "get_documents",
321321
"requestBody": {
322322
"content": {

docs/_src/api/openapi/openapi.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -316,7 +316,7 @@
316316
"document"
317317
],
318318
"summary": "Get Documents",
319-
"description": "This endpoint allows you to retrieve documents contained in your document store.\nYou can filter the documents to delete by metadata (like the document's name),\nor provide an empty JSON object to clear the document store.\n\nExample of filters:\n`'{\"filters\": {{\"name\": [\"some\", \"more\"], \"category\": [\"only_one\"]}}'`\n\nTo get all documents you should provide an empty dict, like:\n`'{\"filters\": {}}'`",
319+
"description": "This endpoint allows you to retrieve documents contained in your document store.\nYou can filter the documents to retrieve by metadata (like the document's name),\nor provide an empty JSON object to clear the document store.\n\nExample of filters:\n`'{\"filters\": {{\"name\": [\"some\", \"more\"], \"category\": [\"only_one\"]}}'`\n\nTo get all documents you should provide an empty dict, like:\n`'{\"filters\": {}}'`",
320320
"operationId": "get_documents",
321321
"requestBody": {
322322
"content": {

rest_api/controller/document.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
def get_documents(filters: FilterRequest):
2525
"""
2626
This endpoint allows you to retrieve documents contained in your document store.
27-
You can filter the documents to delete by metadata (like the document's name),
27+
You can filter the documents to retrieve by metadata (like the document's name),
2828
or provide an empty JSON object to clear the document store.
2929
3030
Example of filters:

0 commit comments

Comments
 (0)