deepset-ai/haystack
1
0
Fork 0
mirror of https://github.com/deepset-ai/haystack.git synced 2026-10-12 02:12:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore: fix typo in API docs (#3023)

Browse Source 
* chore: fix typo in API docs

* fix openapi

Co-authored-by: Thomas Stadelmann <[email protected]>
This commit is contained in:
Julian Risch
2022-08-15 13:25:20 +02:00
committed by GitHub
co-authored by Thomas Stadelmann
parent 0aa0c68785
commit d61755322f
3 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/_src/api/openapi/openapi-1.6.1rc0.json
+1 -1
View File
@@ -316,7 +316,7 @@
"document"
],
"summary": "Get Documents",
"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\": {}}'`",
"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\": {}}'`",
"operationId": "get_documents",
"requestBody": {
"content": {
docs/_src/api/openapi/openapi.json
+1 -1
View File
@@ -316,7 +316,7 @@
"document"
],
"summary": "Get Documents",
"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\": {}}'`",
"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\": {}}'`",
"operationId": "get_documents",
"requestBody": {
"content": {
rest_api/controller/document.py
+1 -1
View File
@@ -24,7 +24,7 @@ document_store: BaseDocumentStore = get_pipelines().get("document_store", None)
def get_documents(filters: FilterRequest):
"""
This endpoint allows you to retrieve documents contained in your document store.
You can filter the documents to delete by metadata (like the document's name),
You can filter the documents to retrieve by metadata (like the document's name),
or provide an empty JSON object to clear the document store.
Example of filters: