An open source search engine for building delightful search experiences.
This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.
org.openapitools.codegen.languages.RustClientCodegenPut the package under your project folder in a directory named openapi and add the following to Cargo.toml under [dependencies]:
openapi = { path = "./openapi" }
All URIs are relative to http://localhost
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- CollectionsApi | createcollection | POST /collections | Create a new collection *CollectionsApi* | deletealias | DELETE /aliases/{aliasName} | Delete an alias CollectionsApi | deletecollection | DELETE /collections/{collectionName} | Delete a collection *CollectionsApi* | getalias | GET /aliases/{aliasName} | Retrieve an alias CollectionsApi | getaliases | GET /aliases | List all aliases *CollectionsApi* | getcollection | GET /collections/{collectionName} | Retrieve a single collection CollectionsApi | getcollections | GET /collections | List all collections *CollectionsApi* | updatecollection | PATCH /collections/{collectionName} | Update a collection CollectionsApi | upsertalias | PUT /aliases/{aliasName} | Create or update a collection alias *DebugApi* | debug | GET /debug | Print debugging information *DocumentsApi* | deletedocument | DELETE /collections/{collectionName}/documents/{documentId} | Delete a document DocumentsApi | deletedocuments | DELETE /collections/{collectionName}/documents | Delete a bunch of documents *DocumentsApi* | deletesearchoverride | DELETE /collections/{collectionName}/overrides/{overrideId} | Delete an override associated with a collection *DocumentsApi* | deletesearchsynonym | DELETE /collections/{collectionName}/synonyms/{synonymId} | Delete a synonym associated with a collection *DocumentsApi* | exportdocuments | GET /collections/{collectionName}/documents/export | Export all documents in a collection DocumentsApi | getdocument | GET /collections/{collectionName}/documents/{documentId} | Retreive a document *DocumentsApi* | getsearchoverride | GET /collections/{collectionName}/overrides/{overrideId} | Retrieve a single search override *DocumentsApi* | getsearchoverrides | GET /collections/{collectionName}/overrides | List all collection overrides *DocumentsApi* | getsearchsynonym | GET /collections/{collectionName}/synonyms/{synonymId} | Retrieve a single search synonym *DocumentsApi* | getsearchsynonyms | GET /collections/{collectionName}/synonyms | List all collection synonyms *DocumentsApi* | importdocuments | POST /collections/{collectionName}/documents/import | Import documents into a collection DocumentsApi | indexdocument | POST /collections/{collectionName}/documents | Index a document *DocumentsApi* | multisearch | POST /multisearch | send multiple search requests in a single HTTP request *DocumentsApi* | searchcollection | GET /collections/{collectionName}/documents/search | Search for documents in a collection DocumentsApi | updatedocument | PATCH /collections/{collectionName}/documents/{documentId} | Update a document *DocumentsApi* | upsertsearchoverride | PUT /collections/{collectionName}/overrides/{overrideId} | Create or update an override to promote certain documents over others *DocumentsApi* | upsertsearchsynonym | PUT /collections/{collectionName}/synonyms/{synonymId} | Create or update a synonym *HealthApi* | health | GET /health | Checks if Typesense server is ready to accept requests. *KeysApi* | createkey | POST /keys | Create an API Key KeysApi | deletekey | DELETE /keys/{keyId} | Delete an API key given its ID. *KeysApi* | getkey | GET /keys/{keyId} | Retrieve (metadata about) a key KeysApi | getkeys | GET /keys | Retrieve (metadata about) all keys. *OperationsApi* | takesnapshot | POST /operations/snapshot | Creates a point-in-time snapshot of a Typesense node's state and data in the specified directory. OperationsApi | vote | POST /operations/vote | Triggers a follower node to initiate the raft voting process, which triggers leader re-election. OverrideApi | getsearchoverride | GET /collections/{collectionName}/overrides/{overrideId} | Retrieve a single search override PromoteApi | deletesearchoverride | DELETE /collections/{collectionName}/overrides/{overrideId} | Delete an override associated with a collection PromoteApi | getsearchoverrides | GET /collections/{collectionName}/overrides | List all collection overrides PromoteApi | upsertsearchoverride | PUT /collections/{collectionName}/overrides/{overrideId} | Create or update an override to promote certain documents over others
To get access to the crate's generated documentation, use:
cargo doc --open