Skip to content

Commit f8be565

Browse files
committed
docs(api): add deprecation note for text search endpoint
Add deprecation notice to /indexes/{name}/search/text endpoint indicating it will be removed once iscc-web supports dedicated simprint generation. Simprint processing requires heavy dependencies and should be delegated to a separate service.
1 parent 92ee03e commit f8be565

File tree

3 files changed

+7
-1
lines changed

3 files changed

+7
-1
lines changed

iscc_search/openapi/openapi.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -740,7 +740,7 @@
740740
"/indexes/{name}/search/text": {
741741
"post": {
742742
"summary": "Search by plain text",
743-
"description": "Generates simprints from the provided text and searches for similar content\nsegments in the index. Returns chunk-level matches based on text similarity.\n",
743+
"description": "Generates simprints from the provided text and searches for similar content\nsegments in the index. Returns chunk-level matches based on text similarity.\n\n**Note**: This endpoint will be removed once iscc-web supports dedicated simprint generation.\nSimprint generation requires heavy dependencies and should be handled by a separate service.\n",
744744
"operationId": "searchText",
745745
"tags": [
746746
"search"

iscc_search/openapi/openapi.yaml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -484,6 +484,9 @@ paths:
484484
description: |
485485
Generates simprints from the provided text and searches for similar content
486486
segments in the index. Returns chunk-level matches based on text similarity.
487+
488+
**Note**: This endpoint will be removed once iscc-web supports dedicated simprint generation.
489+
Simprint generation requires heavy dependencies and should be handled by a separate service.
487490
operationId: searchText
488491
tags:
489492
- search

iscc_search/server/search.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,9 @@ def search_text(
9292
If iscc-sct is installed, also generates SEMANTIC_TEXT_V0 simprints.
9393
Returns chunk-level matches based on text similarity.
9494
95+
**Note**: TODO - This endpoint will be removed once iscc-web supports dedicated simprint generation.
96+
Simprint generation requires heavy dependencies and should be handled by a separate service.
97+
9598
:param name: Index name
9699
:param text_query: TextQuery with plain text content
97100
:param limit: Maximum number of results to return (default: 100)

0 commit comments

Comments
 (0)