Skip to content

Commit 0fd5d59

Browse files
update wording for query description
1 parent b6e0470 commit 0fd5d59

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

.well-known/openapi.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ paths:
5555
/query:
5656
post:
5757
summary: Query
58-
description: Accepts a collection name and an objects array with each item having a search query and an optional filter. Break down complex queries into sub-queries. Refine results by criteria, e.g. time / source, don't do this often. Split queries if ResponseTooLargeError occurs.
58+
description: Accepts a collection name and an objects array with each item having a query and an optional filter. Break down complex queries into sub-queries. Refine results by criteria, e.g. time / source, don't do this often. Split queries if ResponseTooLargeError occurs.
5959
operationId: query_query_post
6060
requestBody:
6161
content:

server/main.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -264,7 +264,7 @@ async def query_main(
264264
"/query",
265265
response_model=QueryResponse,
266266
# NOTE: We are describing the shape of the API endpoint input due to a current limitation in parsing arrays of objects from OpenAPI schemas. This will not be necessary in the future.
267-
description="Accepts a collection name and an objects array with each item having a search query and an optional filter. Break down complex queries into sub-queries. Refine results by criteria, e.g. time / source, don't do this often. Split queries if ResponseTooLargeError occurs.",
267+
description="Accepts a collection name and an objects array with each item having a query and an optional filter. Break down complex queries into sub-queries. Refine results by criteria, e.g. time / source, don't do this often. Split queries if ResponseTooLargeError occurs.",
268268
)
269269
async def query(
270270
api_key: str = Depends(validate_api_key),

0 commit comments

Comments
 (0)