Skip to content

Commit ebe9aae

Browse files
authored
docs: add synonyms tag to API spec (#78)
* add synonyms tag definition with documentation links * add synonyms tag alongside documents for synonym endpoints * clarify API endpoint categorization in swagger UI
1 parent 33dc957 commit ebe9aae

1 file changed

Lines changed: 9 additions & 4 deletions

File tree

openapi.yml

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,11 @@ tags:
5656
externalDocs:
5757
description: Find out more
5858
url: https://typesense.org/docs/27.0/api/conversational-search-rag.html
59+
- name: synonyms
60+
description: Manage synonyms
61+
externalDocs:
62+
description: Find out more
63+
url: https://typesense.org/docs/27.0/api/synonyms.html
5964
paths:
6065
/collections:
6166
get:
@@ -534,7 +539,7 @@ paths:
534539
/collections/{collectionName}/synonyms:
535540
get:
536541
tags:
537-
- documents
542+
- synonyms
538543
summary: List all collection synonyms
539544
operationId: getSearchSynonyms
540545
parameters:
@@ -560,7 +565,7 @@ paths:
560565
/collections/{collectionName}/synonyms/{synonymId}:
561566
get:
562567
tags:
563-
- documents
568+
- synonyms
564569
summary: Retrieve a single search synonym
565570
description: Retrieve the details of a search synonym, given its id.
566571
operationId: getSearchSynonym
@@ -592,7 +597,7 @@ paths:
592597
$ref: "#/components/schemas/ApiResponse"
593598
put:
594599
tags:
595-
- documents
600+
- synonyms
596601
summary: Create or update a synonym
597602
description: Create or update a synonym to define search terms that should be considered equivalent.
598603
operationId: upsertSearchSynonym
@@ -631,7 +636,7 @@ paths:
631636
$ref: "#/components/schemas/ApiResponse"
632637
delete:
633638
tags:
634-
- documents
639+
- synonyms
635640
summary: Delete a synonym associated with a collection
636641
operationId: deleteSearchSynonym
637642
parameters:

0 commit comments

Comments
 (0)