{ "opencollection": "1.0.0", "info": { "name": "Typesense Analytics Analytics Events Synonym Sets API", "version": "30.1" }, "request": { "auth": { "type": "apikey", "key": "X-TYPESENSE-API-KEY", "value": "{{X-TYPESENSE-API-KEY}}", "placement": "header" } }, "items": [ { "info": { "name": "Synonym Sets", "type": "folder" }, "items": [ { "info": { "name": "List All Synonym Sets", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}:{port}/synonym_sets" }, "docs": "Retrieves all synonym sets defined in the Typesense instance. Synonym sets are top-level resources that can be shared across collections." }, { "info": { "name": "Retrieve A Synonym Set", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}:{port}/synonym_sets/:synonymSetName", "params": [ { "name": "synonymSetName", "value": "", "type": "path", "description": "Name of the synonym set." } ] }, "docs": "Retrieves a specific synonym set by name." }, { "info": { "name": "Create Or Update A Synonym Set", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}:{port}/synonym_sets/:synonymSetName", "params": [ { "name": "synonymSetName", "value": "", "type": "path", "description": "Name of the synonym set." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new synonym set or updates an existing one by name." }, { "info": { "name": "Delete A Synonym Set", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}:{port}/synonym_sets/:synonymSetName", "params": [ { "name": "synonymSetName", "value": "", "type": "path", "description": "Name of the synonym set." } ] }, "docs": "Deletes a synonym set by name." }, { "info": { "name": "List Items In A Synonym Set", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}:{port}/synonym_sets/:synonymSetName/items", "params": [ { "name": "synonymSetName", "value": "", "type": "path", "description": "Name of the synonym set." } ] }, "docs": "Retrieves all synonym items within a specific synonym set." }, { "info": { "name": "Retrieve A Synonym Set Item", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}:{port}/synonym_sets/:synonymSetName/items/:itemId", "params": [ { "name": "synonymSetName", "value": "", "type": "path", "description": "Name of the synonym set." }, { "name": "itemId", "value": "", "type": "path", "description": "ID of the item within a set." } ] }, "docs": "Retrieves a specific synonym item by ID from a synonym set." }, { "info": { "name": "Create Or Update A Synonym Set Item", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}:{port}/synonym_sets/:synonymSetName/items/:itemId", "params": [ { "name": "synonymSetName", "value": "", "type": "path", "description": "Name of the synonym set." }, { "name": "itemId", "value": "", "type": "path", "description": "ID of the item within a set." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates or updates a synonym item within a synonym set." }, { "info": { "name": "Delete A Synonym Set Item", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}:{port}/synonym_sets/:synonymSetName/items/:itemId", "params": [ { "name": "synonymSetName", "value": "", "type": "path", "description": "Name of the synonym set." }, { "name": "itemId", "value": "", "type": "path", "description": "ID of the item within a set." } ] }, "docs": "Deletes a specific synonym item from a synonym set." } ] } ], "bundled": true }