diff --git a/.code-samples.meilisearch.yaml b/.code-samples.meilisearch.yaml index 2d42497c..7b4ab941 100644 --- a/.code-samples.meilisearch.yaml +++ b/.code-samples.meilisearch.yaml @@ -449,7 +449,7 @@ add_movies_json_1: |- Path fileName = Path.of("movies.json"); String moviesJson = Files.readString(fileName); - Client client = new Client(new Config("MEILISEARCH_URL", "masterKey")); + Client client = new Client(new Config("MEILISEARCH_URL", "MEILISEARCH_KEY")); Index index = client.index("movies"); index.addDocuments(moviesJson); post_dump_1: |- @@ -537,7 +537,7 @@ primary_field_guide_add_document_primary_key: |- + "}]" , "reference_number"); authorization_header_1: |- - Client client = new Client(new Config("MEILISEARCH_URL", "masterKey")); + Client client = new Client(new Config("MEILISEARCH_URL", "MEILISEARCH_KEY")); client.getKeys(); tenant_token_guide_generate_sdk_1: |- Map filters = new HashMap(); @@ -634,7 +634,7 @@ webhooks_get_single_1: |- client.getWebhook(); webhooks_post_1: |- HashMap headers = new HashMap<>(); - headers.put("authorization", "MASTER_KEY"); + headers.put("authorization", "MEILISEARCH_KEY"); headers.put("referer", "http://example.com"); CreateUpdateWebhookRequest webhookReq1 = new CreateUpdateWebhookRequest("http://webiste.com", headers); diff --git a/README.md b/README.md index 95e6cbb9..c9c1e955 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ Discord | Roadmap | Website | - FAQ + FAQ

@@ -116,7 +116,7 @@ class TestMeilisearch { } ``` -With the `taskUid`, you can check the status (`enqueued`, `canceled`, `processing`, `succeeded` or `failed`) of your documents addition using the [task endpoint](https://www.meilisearch.com/docs/reference/api/tasks). +With the `taskUid`, you can check the status (`enqueued`, `canceled`, `processing`, `succeeded` or `failed`) of your documents addition using the [task endpoint](https://www.meilisearch.com/docs/reference/api/async-task-management/list-tasks). #### Basic Search @@ -139,7 +139,7 @@ SearchResult(hits=[{id=1.0, title=Carol, genres:[Romance, Drama]}], offset=0, li #### Custom Search If you want a custom search, the easiest way is to create a `SearchRequest` object, and set the parameters that you need.
-All the supported options are described in the [search parameters](https://www.meilisearch.com/docs/reference/api/search#search-parameters) section of the documentation. +All the supported options are described in the [search parameters](https://www.meilisearch.com/docs/reference/api/search/search-with-post#search-parameters) section of the documentation. ```java import com.meilisearch.sdk.SearchRequest; @@ -188,7 +188,7 @@ index.updateFilterableAttributesSettings(new String[] You only need to perform this operation once. -Note that Meilisearch will rebuild your index whenever you update `filterableAttributes`. Depending on the size of your dataset, this might take time. You can track the process using the [task status](https://www.meilisearch.com/docs/reference/api/tasks). +Note that Meilisearch will rebuild your index whenever you update `filterableAttributes`. Depending on the size of your dataset, this might take time. You can track the process using the [task status](https://www.meilisearch.com/docs/reference/api/async-task-management/list-tasks). Then, you can perform the search: @@ -300,10 +300,10 @@ This SDK is compatible with the following JDK versions: The following sections in our main documentation website may interest you: -- **Manipulate documents**: see the [API references](https://www.meilisearch.com/docs/reference/api/documents) or read more about [documents](https://www.meilisearch.com/docs/learn/core_concepts/documents). -- **Search**: see the [API references](https://www.meilisearch.com/docs/reference/api/search) or follow our guide on [search parameters](https://www.meilisearch.com/docs/reference/api/search#search-parameters). -- **Manage the indexes**: see the [API references](https://www.meilisearch.com/docs/reference/api/indexes) or read more about [indexes](https://www.meilisearch.com/docs/learn/core_concepts/indexes). -- **Configure the index settings**: see the [API references](https://www.meilisearch.com/docs/reference/api/settings) or follow our guide on [settings parameters](https://www.meilisearch.com/docs/reference/api/settings#settings_parameters). +- **Manipulate documents**: see the [API references](https://www.meilisearch.com/docs/reference/api/documents/list-documents-with-get) or read more about [documents](https://www.meilisearch.com/docs/learn/getting_started/documents). +- **Search**: see the [API references](https://www.meilisearch.com/docs/reference/api/search/search-with-post) or follow our guide on [search parameters](https://www.meilisearch.com/docs/reference/api/search/search-with-post#search-parameters). +- **Manage the indexes**: see the [API references](https://www.meilisearch.com/docs/reference/api/indexes/list-all-indexes) or read more about [indexes](https://www.meilisearch.com/docs/learn/getting_started/indexes). +- **Configure the index settings**: see the [API references](https://www.meilisearch.com/docs/reference/api/settings/list-all-settings) or follow our guide on [settings parameters](https://www.meilisearch.com/docs/reference/api/settings/list-all-settings#settings_parameters). ## ⚙️ Contributing diff --git a/src/main/java/com/meilisearch/sdk/Client.java b/src/main/java/com/meilisearch/sdk/Client.java index 37e250eb..244d988f 100644 --- a/src/main/java/com/meilisearch/sdk/Client.java +++ b/src/main/java/com/meilisearch/sdk/Client.java @@ -43,7 +43,7 @@ public Client(Config config) { * @param uid Unique identifier for the index to create * @return Meilisearch API response as TaskInfo * @throws MeilisearchException if an error occurs - * @see API + * @see API * specification */ public TaskInfo createIndex(String uid) throws MeilisearchException { @@ -57,7 +57,7 @@ public TaskInfo createIndex(String uid) throws MeilisearchException { * @param primaryKey The primary key of the documents in that index * @return Meilisearch API response as TaskInfo * @throws MeilisearchException if an error occurs - * @see API + * @see API * specification */ public TaskInfo createIndex(String uid, String primaryKey) throws MeilisearchException { @@ -69,7 +69,7 @@ public TaskInfo createIndex(String uid, String primaryKey) throws MeilisearchExc * * @return Results containing a list of indexes from the Meilisearch API * @throws MeilisearchException if an error occurs - * @see API + * @see API * specification */ public Results getIndexes() throws MeilisearchException { @@ -86,7 +86,7 @@ public Results getIndexes() throws MeilisearchException { * @param params query parameters accepted by the get indexes route * @return Results containing a list of indexes from the Meilisearch API * @throws MeilisearchException if an error occurs - * @see API + * @see API * specification */ public Results getIndexes(IndexesQuery params) throws MeilisearchException { @@ -102,7 +102,7 @@ public Results getIndexes(IndexesQuery params) throws MeilisearchExceptio * * @return List of indexes from the Meilisearch API as String * @throws MeilisearchException if an error occurs - * @see API + * @see API * specification */ public String getRawIndexes() throws MeilisearchException { @@ -115,7 +115,7 @@ public String getRawIndexes() throws MeilisearchException { * @param params query parameters accepted by the get indexes route * @return List of indexes from the Meilisearch API as String * @throws MeilisearchException if an error occurs - * @see API + * @see API * specification */ public String getRawIndexes(IndexesQuery params) throws MeilisearchException { @@ -144,7 +144,7 @@ public Index index(String uid) throws MeilisearchException { * @param uid Unique identifier of the index to get * @return Meilisearch API response as Index instance * @throws MeilisearchException if an error occurs - * @see API + * @see API * specification */ public Index getIndex(String uid) throws MeilisearchException { @@ -160,7 +160,7 @@ public Index getIndex(String uid) throws MeilisearchException { * @param primaryKey Primary key of the documents in the index * @return Meilisearch API response as TaskInfo * @throws MeilisearchException if an error occurs - * @see API + * @see API * specification */ public TaskInfo updateIndex(String uid, String primaryKey) throws MeilisearchException { @@ -182,7 +182,7 @@ public TaskInfo updateIndex(String uid, String primaryKey, String indexUid) * @param uid Unique identifier of the index to delete * @return Meilisearch API response as TaskInfo * @throws MeilisearchException if an error occurs - * @see API + * @see API * specification */ public TaskInfo deleteIndex(String uid) throws MeilisearchException { @@ -195,7 +195,7 @@ public TaskInfo deleteIndex(String uid) throws MeilisearchException { * @param param accepted by the swap-indexes route * @return Meilisearch API response as TaskInfo * @throws MeilisearchException if an error occurs - * @see API + * @see API * specification */ public TaskInfo swapIndexes(SwapIndexesParams[] param) throws MeilisearchException { @@ -207,7 +207,7 @@ public TaskInfo swapIndexes(SwapIndexesParams[] param) throws MeilisearchExcepti * * @return Meilisearch API response as TaskInfo * @throws MeilisearchException if an error occurs - * @see API + * @see API * specification */ public TaskInfo createDump() throws MeilisearchException { @@ -219,7 +219,7 @@ public TaskInfo createDump() throws MeilisearchException { * * @return Meilisearch API response as TaskInfo * @throws MeilisearchException if an error occurs - * @see API specification + * @see API specification */ public TaskInfo createSnapshot() throws MeilisearchException { return config.httpClient.post("/snapshots", "", TaskInfo.class); @@ -231,7 +231,7 @@ public TaskInfo createSnapshot() throws MeilisearchException { * @param request Export request parameters * @return Meilisearch API response as TaskInfo * @throws MeilisearchException if an error occurs - * @see API specification + * @see API specification */ public TaskInfo export(ExportRequest request) throws MeilisearchException { return config.httpClient.post("/export", request, TaskInfo.class); @@ -243,7 +243,7 @@ public TaskInfo export(ExportRequest request) throws MeilisearchException { * @return String containing the status of the Meilisearch instance from Meilisearch API * response * @throws MeilisearchException if an error occurs - * @see API + * @see API * specification */ public String health() throws MeilisearchException { @@ -255,7 +255,7 @@ public String health() throws MeilisearchException { * * @return True if the Meilisearch instance is available or false if it is not * @throws MeilisearchException if an error occurs - * @see API + * @see API * specification */ public Boolean isHealthy() throws MeilisearchException { @@ -267,7 +267,7 @@ public Boolean isHealthy() throws MeilisearchException { * * @return Stats instance from Meilisearch API response * @throws MeilisearchException if an error occurs - * @see API + * @see API * specification */ public Stats getStats() throws MeilisearchException { @@ -279,7 +279,7 @@ public Stats getStats() throws MeilisearchException { * * @return Meilisearch API response * @throws MeilisearchException if an error occurs - * @see API + * @see API * specification */ public String getVersion() throws MeilisearchException { @@ -292,7 +292,7 @@ public String getVersion() throws MeilisearchException { * @param uid Identifier of the requested Task * @return Meilisearch API response as Task Instance * @throws MeilisearchException if an error occurs - * @see API + * @see API * specification */ public Task getTask(int uid) throws MeilisearchException { @@ -304,7 +304,7 @@ public Task getTask(int uid) throws MeilisearchException { * * @return TasksResults containing a list of tasks from the Meilisearch API * @throws MeilisearchException if an error occurs - * @see API + * @see API * specification */ public TasksResults getTasks() throws MeilisearchException { @@ -317,7 +317,7 @@ public TasksResults getTasks() throws MeilisearchException { * @param param accept by the tasks route * @return TasksResults containing a list of tasks from the Meilisearch API * @throws MeilisearchException if an error occurs - * @see API + * @see API * specification */ public TasksResults getTasks(TasksQuery param) throws MeilisearchException { @@ -330,7 +330,7 @@ public TasksResults getTasks(TasksQuery param) throws MeilisearchException { * @param param accept by the tasks route * @return Meilisearch API response as TaskInfo * @throws MeilisearchException if an error occurs - * @see API + * @see API * specification */ public TaskInfo cancelTasks(CancelTasksQuery param) throws MeilisearchException { @@ -343,7 +343,7 @@ public TaskInfo cancelTasks(CancelTasksQuery param) throws MeilisearchException * @param param accept by the tasks route * @return Meilisearch API response as TaskInfo * @throws MeilisearchException if an error occurs - * @see API + * @see API * specification */ public TaskInfo deleteTasks(DeleteTasksQuery param) throws MeilisearchException { @@ -389,7 +389,7 @@ public CursorResults getAllBatches(BatchesQuery batchesQuery) * @param uid Identifier of the requested Key * @return Meilisearch API response as Key Instance * @throws MeilisearchException if an error occurs - * @see API + * @see API * specification */ public Key getKey(String uid) throws MeilisearchException { @@ -401,7 +401,7 @@ public Key getKey(String uid) throws MeilisearchException { * * @return Results containing a list of Key from the Meilisearch API * @throws MeilisearchException if an error occurs - * @see API + * @see API * specification */ public Results getKeys() throws MeilisearchException { @@ -414,7 +414,7 @@ public Results getKeys() throws MeilisearchException { * @param params query parameters accepted by the get keys route * @return Results containing a list of Key from the Meilisearch API * @throws MeilisearchException if an error occurs - * @see API + * @see API * specification */ public Results getKeys(KeysQuery params) throws MeilisearchException { @@ -427,7 +427,7 @@ public Results getKeys(KeysQuery params) throws MeilisearchException { * @param options Key containing the options of the key * @return Meilisearch API response as Key Instance * @throws MeilisearchException if an error occurs - * @see API + * @see API * specification */ public Key createKey(Key options) throws MeilisearchException { @@ -441,7 +441,7 @@ public Key createKey(Key options) throws MeilisearchException { * @param options String containing the options to update * @return Meilisearch API response as Key Instance * @throws MeilisearchException if an error occurs - * @see API + * @see API * specification */ public Key updateKey(String key, KeyUpdate options) throws MeilisearchException { @@ -453,7 +453,7 @@ public Key updateKey(String key, KeyUpdate options) throws MeilisearchException * * @param key String containing the key * @throws MeilisearchException if an error occurs - * @see API + * @see API * specification */ public void deleteKey(String key) throws MeilisearchException { @@ -500,7 +500,7 @@ public String generateTenantToken(String apiKeyUid, Map searchRu * @return String containing the tenant token * @throws MeilisearchException if an error occurs * @see Meilisearch + * href="https://www.meilisearch.com/docs/learn/security/generate_tenant_token_sdk#multitenancy-and-tenant-tokens">Meilisearch * Tenant Tokens */ public String generateTenantToken( diff --git a/src/main/java/com/meilisearch/sdk/Documents.java b/src/main/java/com/meilisearch/sdk/Documents.java index ce671fba..51ab61f6 100644 --- a/src/main/java/com/meilisearch/sdk/Documents.java +++ b/src/main/java/com/meilisearch/sdk/Documents.java @@ -12,7 +12,7 @@ /** * Class covering the Meilisearch Document API * - * @see API specification + * @see API specification */ class Documents { private final HttpClient httpClient; diff --git a/src/main/java/com/meilisearch/sdk/FacetSearch.java b/src/main/java/com/meilisearch/sdk/FacetSearch.java index c1774bb7..aaf4b01b 100644 --- a/src/main/java/com/meilisearch/sdk/FacetSearch.java +++ b/src/main/java/com/meilisearch/sdk/FacetSearch.java @@ -7,7 +7,7 @@ /** * Class used for performing facet searching on Meilisearch indexes * - * @see API specification + * @see API specification */ public class FacetSearch { private final HttpClient httpClient; diff --git a/src/main/java/com/meilisearch/sdk/Index.java b/src/main/java/com/meilisearch/sdk/Index.java index 97d397b7..b47ea671 100644 --- a/src/main/java/com/meilisearch/sdk/Index.java +++ b/src/main/java/com/meilisearch/sdk/Index.java @@ -51,7 +51,7 @@ void setConfig(Config config) { * @param targetClass Class of the document returned * @return Object containing the requested document * @throws MeilisearchException if an error occurs - * @see API + * @see API * specification */ public T getDocument(String identifier, Class targetClass) throws MeilisearchException { @@ -67,7 +67,7 @@ public T getDocument(String identifier, Class targetClass) throws Meilise * @param targetClass Class of documents returned * @return Object containing the requested document * @throws MeilisearchException if an error occurs - * @see API + * @see API * specification */ public T getDocument(String identifier, DocumentQuery param, Class targetClass) @@ -81,7 +81,7 @@ public T getDocument(String identifier, DocumentQuery param, Class target * @param identifier Identifier of the document to get * @return String containing the requested document * @throws MeilisearchException if an error occurs - * @see API + * @see API * specification */ public String getRawDocument(String identifier) throws MeilisearchException { @@ -95,7 +95,7 @@ public String getRawDocument(String identifier) throws MeilisearchException { * @param param accept by the documents route * @return String containing the requested document * @throws MeilisearchException if an error occurs - * @see API + * @see API * specification */ public String getRawDocument(String identifier, DocumentQuery param) @@ -110,7 +110,7 @@ public String getRawDocument(String identifier, DocumentQuery param) * @param targetClass Class of documents returned * @return Results containing a list of Object containing the requested document * @throws MeilisearchException if an error occurs - * @see API + * @see API * specification */ public Results getDocuments(Class targetClass) throws MeilisearchException { @@ -125,7 +125,7 @@ public Results getDocuments(Class targetClass) throws MeilisearchExcep * @param targetClass Class of documents returned * @return Results containing a list of Object containing the requested document * @throws MeilisearchException if an error occurs - * @see API + * @see API * specification */ public Results getDocuments(DocumentsQuery param, Class targetClass) @@ -138,7 +138,7 @@ public Results getDocuments(DocumentsQuery param, Class targetClass) * * @return String containing a list of documents * @throws MeilisearchException if an error occurs - * @see API + * @see API * specification */ public String getRawDocuments() throws MeilisearchException { @@ -151,7 +151,7 @@ public String getRawDocuments() throws MeilisearchException { * @param param accept by the documents route * @return String containing a list of documents * @throws MeilisearchException if an error occurs - * @see API + * @see API * specification */ public String getRawDocuments(DocumentsQuery param) throws MeilisearchException { @@ -165,7 +165,7 @@ public String getRawDocuments(DocumentsQuery param) throws MeilisearchException * @return TaskInfo Meilisearch API response * @throws MeilisearchException if an error occurs * @see API + * href="https://www.meilisearch.com/docs/reference/api/documents/list-documents-with-get#add-or-replace-documents">API * specification */ public TaskInfo addDocuments(String document) throws MeilisearchException { @@ -180,7 +180,7 @@ public TaskInfo addDocuments(String document) throws MeilisearchException { * @return TaskInfo Meilisearch API response * @throws MeilisearchException if an error occurs * @see API + * href="https://www.meilisearch.com/docs/reference/api/documents/list-documents-with-get#add-or-replace-documents">API * specification */ public TaskInfo addDocuments(String document, String primaryKey) throws MeilisearchException { @@ -196,7 +196,7 @@ public TaskInfo addDocuments(String document, String primaryKey) throws Meilisea * @return TaskInfo Meilisearch API response * @throws MeilisearchException if an error occurs * @see API + * href="https://www.meilisearch.com/docs/reference/api/documents/list-documents-with-get#add-or-replace-documents">API * specification */ public TaskInfo addDocuments(String document, String primaryKey, String csvDelimiter) @@ -214,7 +214,7 @@ public TaskInfo addDocuments(String document, String primaryKey, String csvDelim * @return TaskInfo Meilisearch API response * @throws MeilisearchException if an error occurs * @see API + * href="https://www.meilisearch.com/docs/reference/api/documents/list-documents-with-get#add-or-replace-documents">API * specification */ public TaskInfo addDocuments( @@ -233,7 +233,7 @@ public TaskInfo addDocuments( * @return TaskInfo Meilisearch API response * @throws MeilisearchException if an error occurs * @see API + * href="https://www.meilisearch.com/docs/reference/api/documents/list-documents-with-get#add-or-replace-documents">API * specification */ public TaskInfo[] addDocumentsInBatches(String document, Integer batchSize, String primaryKey) @@ -264,7 +264,7 @@ public TaskInfo[] addDocumentsInBatches(String document, Integer batchSize, Stri * @return TaskInfo Meilisearch API response * @throws MeilisearchException if an error occurs * @see API + * href="https://www.meilisearch.com/docs/reference/api/documents/list-documents-with-get#add-or-replace-documents">API * specification */ public TaskInfo[] addDocumentsInBatches(String document) throws MeilisearchException { @@ -278,7 +278,7 @@ public TaskInfo[] addDocumentsInBatches(String document) throws MeilisearchExcep * @return TaskInfo Meilisearch API response * @throws MeilisearchException if an error occurs * @see API + * href="https://www.meilisearch.com/docs/reference/api/documents/list-documents-with-get#add-or-replace-documents">API * specification */ public TaskInfo updateDocuments(String document) throws MeilisearchException { @@ -293,7 +293,7 @@ public TaskInfo updateDocuments(String document) throws MeilisearchException { * @return TaskInfo Meilisearch API response * @throws MeilisearchException if an error occurs * @see API + * href="https://www.meilisearch.com/docs/reference/api/documents/list-documents-with-get#add-or-replace-documents">API * specification */ public TaskInfo updateDocuments(String document, String primaryKey) @@ -310,7 +310,7 @@ public TaskInfo updateDocuments(String document, String primaryKey) * @return TaskInfo Meilisearch API response * @throws MeilisearchException if an error occurs * @see API + * href="https://www.meilisearch.com/docs/reference/api/documents/list-documents-with-get#add-or-replace-documents">API * specification */ public TaskInfo updateDocuments(String document, String primaryKey, String csvDelimiter) @@ -328,7 +328,7 @@ public TaskInfo updateDocuments(String document, String primaryKey, String csvDe * @return TaskInfo Meilisearch API response * @throws MeilisearchException if an error occurs * @see API + * href="https://www.meilisearch.com/docs/reference/api/documents/list-documents-with-get#add-or-replace-documents">API * specification */ public TaskInfo updateDocuments( @@ -347,7 +347,7 @@ public TaskInfo updateDocuments( * @return TaskInfo Meilisearch API response * @throws MeilisearchException if an error occurs * @see API + * href="https://www.meilisearch.com/docs/reference/api/documents/list-documents-with-get#add-or-replace-documents">API * specification */ public TaskInfo[] updateDocumentsInBatches( @@ -378,7 +378,7 @@ public TaskInfo[] updateDocumentsInBatches( * @return TaskInfo Meilisearch API response * @throws MeilisearchException if an error occurs * @see API + * href="https://www.meilisearch.com/docs/reference/api/documents/list-documents-with-get#add-or-replace-documents">API * specification */ public TaskInfo[] updateDocumentsInBatches(String document) throws MeilisearchException { @@ -392,7 +392,7 @@ public TaskInfo[] updateDocumentsInBatches(String document) throws MeilisearchEx * @return TaskInfo Meilisearch API response * @throws MeilisearchException if an error occurs * @see API + * href="https://www.meilisearch.com/docs/reference/api/documents/list-documents-with-get#delete-one-document">API * specification */ public TaskInfo deleteDocument(String identifier) throws MeilisearchException { @@ -407,7 +407,7 @@ public TaskInfo deleteDocument(String identifier) throws MeilisearchException { * @return TaskInfo Meilisearch API response * @throws MeilisearchException if an error occurs * @see API + * href="https://www.meilisearch.com/docs/reference/api/documents/list-documents-with-get#delete-one-document">API * specification */ public TaskInfo deleteDocument(String identifier, String customMetadata) @@ -422,7 +422,7 @@ public TaskInfo deleteDocument(String identifier, String customMetadata) * @return TaskInfo Meilisearch API response * @throws MeilisearchException if an error occurs * @see API + * href="https://www.meilisearch.com/docs/reference/api/documents/list-documents-with-get#delete-documents-by-batch">API * specification * @see com.meilisearch.sdk.Index#deleteDocumentsByFilter(String) Delete documents using filter */ @@ -439,7 +439,7 @@ public TaskInfo deleteDocuments(List documentsIdentifiers) throws Meilis * @return TaskInfo Meilisearch API response * @throws MeilisearchException if an error occurs * @see API + * href="https://www.meilisearch.com/docs/reference/api/documents/list-documents-with-get#delete-documents-by-batch">API * specification * @see com.meilisearch.sdk.Index#deleteDocumentsByFilter(String) Delete documents using filter */ @@ -456,7 +456,7 @@ public TaskInfo deleteDocuments(List documentsIdentifiers, String custom * @return TaskInfo Meilisearch API response * @throws MeilisearchException if an error occurs * @see API + * href="https://www.meilisearch.com/docs/reference/api/documents/list-documents-with-get#delete-documents-by-filter">API * specification * @since 1.2 */ @@ -472,7 +472,7 @@ public TaskInfo deleteDocumentsByFilter(String filter) throws MeilisearchExcepti * @return TaskInfo Meilisearch API response * @throws MeilisearchException if an error occurs * @see API + * href="https://www.meilisearch.com/docs/reference/api/documents/list-documents-with-get#delete-documents-by-filter">API * specification * @since 1.2 */ @@ -487,7 +487,7 @@ public TaskInfo deleteDocumentsByFilter(String filter, String customMetadata) * @return List of tasks Meilisearch API response * @throws MeilisearchException if an error occurs * @see API + * href="https://www.meilisearch.com/docs/reference/api/documents/list-documents-with-get#delete-all-documents">API * specification */ public TaskInfo deleteAllDocuments() throws MeilisearchException { @@ -501,7 +501,7 @@ public TaskInfo deleteAllDocuments() throws MeilisearchException { * @return List of tasks Meilisearch API response * @throws MeilisearchException if an error occurs * @see API + * href="https://www.meilisearch.com/docs/reference/api/documents/list-documents-with-get#delete-all-documents">API * specification */ public TaskInfo deleteAllDocuments(String customMetadata) throws MeilisearchException { @@ -515,7 +515,7 @@ public TaskInfo deleteAllDocuments(String customMetadata) throws MeilisearchExce * @return Meilisearch API response * @throws MeilisearchException if an error occurs * @see API + * href="https://www.meilisearch.com/docs/reference/api/search/search-with-post#search-in-an-index-with-post">API * specification */ public SearchResult search(String q) throws MeilisearchException { @@ -529,7 +529,7 @@ public SearchResult search(String q) throws MeilisearchException { * @return Meilisearch API response * @throws MeilisearchException if an error occurs * @see API + * href="https://www.meilisearch.com/docs/reference/api/search/search-with-post#search-in-an-index-with-post">API * specification */ public Searchable search(SearchRequest searchRequest) throws MeilisearchException { @@ -546,7 +546,7 @@ public Searchable search(SearchRequest searchRequest) throws MeilisearchExceptio * @return Meilisearch API response * @throws MeilisearchException if an error occurs * @see API + * href="https://www.meilisearch.com/docs/reference/api/facet-search/search-in-facets#perform-a-facet-search">API * specification * @see Index#getFilterableAttributesSettings() getFilterableAttributesSettings * @see Index#updateGranularFilterableAttributesSettings(FilterableAttributesConfig[]) @@ -576,7 +576,7 @@ public String rawSearch(SearchRequest searchRequest) throws MeilisearchException * * @return settings of a given uid as String * @throws MeilisearchException if an error occurs - * @see API + * @see API * specification */ public Settings getSettings() throws MeilisearchException { @@ -589,7 +589,7 @@ public Settings getSettings() throws MeilisearchException { * @param settings the object that contains the data with the new settings * @return TaskInfo instance * @throws MeilisearchException if an error occurs - * @see API + * @see API * specification */ public TaskInfo updateSettings(Settings settings) throws MeilisearchException { @@ -601,7 +601,7 @@ public TaskInfo updateSettings(Settings settings) throws MeilisearchException { * * @return TaskInfo instance * @throws MeilisearchException if an error occurs - * @see API + * @see API * specification */ public TaskInfo resetSettings() throws MeilisearchException { @@ -613,7 +613,7 @@ public TaskInfo resetSettings() throws MeilisearchException { * * @return ranking rules of a given uid as String * @throws MeilisearchException if an error occurs - * @see API + * @see API * specification */ public String[] getRankingRulesSettings() throws MeilisearchException { @@ -626,7 +626,7 @@ public String[] getRankingRulesSettings() throws MeilisearchException { * @param rankingRules array that contain the data with the new ranking rules * @return TaskInfo instance * @throws MeilisearchException if an error occurs - * @see API + * @see API * specification */ public TaskInfo updateRankingRulesSettings(String[] rankingRules) throws MeilisearchException { @@ -638,7 +638,7 @@ public TaskInfo updateRankingRulesSettings(String[] rankingRules) throws Meilise * * @return TaskInfo instance * @throws MeilisearchException if an error occurs - * @see API + * @see API * specification */ public TaskInfo resetRankingRulesSettings() throws MeilisearchException { @@ -650,7 +650,7 @@ public TaskInfo resetRankingRulesSettings() throws MeilisearchException { * * @return synonyms of a given uid as String * @throws MeilisearchException if an error occurs - * @see API + * @see API * specification */ public Map getSynonymsSettings() throws MeilisearchException { @@ -663,7 +663,7 @@ public Map getSynonymsSettings() throws MeilisearchException { * @param synonyms key (String) value (array) pair of synonyms * @return TaskInfo instance * @throws MeilisearchException if an error occurs - * @see API + * @see API * specification */ public TaskInfo updateSynonymsSettings(Map synonyms) @@ -676,7 +676,7 @@ public TaskInfo updateSynonymsSettings(Map synonyms) * * @return TaskInfo instance * @throws MeilisearchException if an error occurs - * @see API + * @see API * specification */ public TaskInfo resetSynonymsSettings() throws MeilisearchException { @@ -688,7 +688,7 @@ public TaskInfo resetSynonymsSettings() throws MeilisearchException { * * @return stop-words of a given uid as String * @throws MeilisearchException if an error occurs - * @see API + * @see API * specification */ public String[] getStopWordsSettings() throws MeilisearchException { @@ -701,7 +701,7 @@ public String[] getStopWordsSettings() throws MeilisearchException { * @param stopWords An array of strings that contains the stop-words. * @return TaskInfo instance * @throws MeilisearchException if an error occurs - * @see API + * @see API * specification */ public TaskInfo updateStopWordsSettings(String[] stopWords) throws MeilisearchException { @@ -713,7 +713,7 @@ public TaskInfo updateStopWordsSettings(String[] stopWords) throws MeilisearchEx * * @return TaskInfo instance * @throws MeilisearchException if an error occurs - * @see API + * @see API * specification */ public TaskInfo resetStopWordsSettings() throws MeilisearchException { @@ -726,7 +726,7 @@ public TaskInfo resetStopWordsSettings() throws MeilisearchException { * @return searchable attributes of a given uid as String * @throws MeilisearchException if an error occurs * @see API + * href="https://www.meilisearch.com/docs/reference/api/settings/list-all-settings#get-searchable-attributes">API * specification */ public String[] getSearchableAttributesSettings() throws MeilisearchException { @@ -740,7 +740,7 @@ public String[] getSearchableAttributesSettings() throws MeilisearchException { * @return TaskInfo instance * @throws MeilisearchException if an error occurs * @see API + * href="https://www.meilisearch.com/docs/reference/api/settings/list-all-settings#update-searchable-attributes">API * specification */ public TaskInfo updateSearchableAttributesSettings(String[] searchableAttributes) @@ -755,7 +755,7 @@ public TaskInfo updateSearchableAttributesSettings(String[] searchableAttributes * @return TaskInfo instance * @throws MeilisearchException if an error occurs * @see API + * href="https://www.meilisearch.com/docs/reference/api/settings/list-all-settings#reset-searchable-attributes">API * specification */ public TaskInfo resetSearchableAttributesSettings() throws MeilisearchException { @@ -768,7 +768,7 @@ public TaskInfo resetSearchableAttributesSettings() throws MeilisearchException * @return display attributes of a given uid as String * @throws MeilisearchException if an error occurs * @see API + * href="https://www.meilisearch.com/docs/reference/api/settings/list-all-settings#get-displayed-attributes">API * specification */ public String[] getDisplayedAttributesSettings() throws MeilisearchException { @@ -782,7 +782,7 @@ public String[] getDisplayedAttributesSettings() throws MeilisearchException { * @return TaskInfo instance * @throws MeilisearchException if an error occurs * @see API + * href="https://www.meilisearch.com/docs/reference/api/settings/list-all-settings#update-displayed-attributes">API * specification */ public TaskInfo updateDisplayedAttributesSettings(String[] displayAttributes) @@ -796,7 +796,7 @@ public TaskInfo updateDisplayedAttributesSettings(String[] displayAttributes) * @return TaskInfo instance * @throws MeilisearchException if an error occurs * @see API + * href="https://www.meilisearch.com/docs/reference/api/settings/list-all-settings#reset-displayed-attributes">API * specification */ public TaskInfo resetDisplayedAttributesSettings() throws MeilisearchException { @@ -809,7 +809,7 @@ public TaskInfo resetDisplayedAttributesSettings() throws MeilisearchException { * @return localized attributes of a given uid as LocalizedAttribute * @throws MeilisearchException if an error occurs * @see API + * href="https://www.meilisearch.com/docs/reference/api/settings/list-all-settings#get-localized-attributes">API * specification */ public LocalizedAttribute[] getLocalizedAttributesSettings() throws MeilisearchException { @@ -824,7 +824,7 @@ public LocalizedAttribute[] getLocalizedAttributesSettings() throws MeilisearchE * @return TaskInfo instance * @throws MeilisearchException if an error occurs * @see API + * href="https://www.meilisearch.com/docs/reference/api/settings/list-all-settings#update-localized-attribute-settings">API * specification */ public TaskInfo updateLocalizedAttributesSettings(LocalizedAttribute[] localizedAttributes) @@ -849,7 +849,7 @@ public TaskInfo resetLocalizedAttributesSettings() throws MeilisearchException { * @return filterable attributes of a given uid as String * @throws MeilisearchException if an error occurs or granular configs cannot be reduced * @see API + * href="https://www.meilisearch.com/docs/reference/api/settings/list-all-settings#get-filterable-attributes">API * specification */ public String[] getFilterableAttributesSettings() throws MeilisearchException { @@ -865,7 +865,7 @@ public String[] getFilterableAttributesSettings() throws MeilisearchException { * @return TaskInfo instance * @throws MeilisearchException if an error occurs * @see API + * href="https://www.meilisearch.com/docs/reference/api/settings/list-all-settings#update-filterable-attributes">API * specification */ public TaskInfo updateFilterableAttributesSettings(String[] filterableAttributes) @@ -880,7 +880,7 @@ public TaskInfo updateFilterableAttributesSettings(String[] filterableAttributes * @return filterable attributes of a given uid as FilterableAttributesConfig[] * @throws MeilisearchException if an error occurs * @see API + * href="https://www.meilisearch.com/docs/reference/api/settings/list-all-settings#get-filterable-attributes">API * specification */ public FilterableAttributesConfig[] getGranularFilterableAttributesSettings() @@ -897,7 +897,7 @@ public FilterableAttributesConfig[] getGranularFilterableAttributesSettings() * @return TaskInfo instance * @throws MeilisearchException if an error occurs * @see API + * href="https://www.meilisearch.com/docs/reference/api/settings/list-all-settings#update-filterable-attributes">API * specification */ public TaskInfo updateGranularFilterableAttributesSettings( @@ -912,7 +912,7 @@ public TaskInfo updateGranularFilterableAttributesSettings( * @return TaskInfo instance * @throws MeilisearchException if an error occurs * @see API + * href="https://www.meilisearch.com/docs/reference/api/settings/list-all-settings#reset-filterable-attributes">API * specification */ public TaskInfo resetFilterableAttributesSettings() throws MeilisearchException { @@ -938,7 +938,7 @@ public TaskInfo resetSortableAttributesSettings() throws MeilisearchException { * @return distinct attribute field of a given uid as String * @throws MeilisearchException if an error occurs * @see API + * href="https://www.meilisearch.com/docs/reference/api/settings/list-all-settings#get-distinct-attribute">API * specification */ public String getDistinctAttributeSettings() throws MeilisearchException { @@ -952,7 +952,7 @@ public String getDistinctAttributeSettings() throws MeilisearchException { * @return TaskInfo instance * @throws MeilisearchException if an error occurs * @see API + * href="https://www.meilisearch.com/docs/reference/api/settings/list-all-settings#update-distinct-attribute">API * specification */ public TaskInfo updateDistinctAttributeSettings(String distinctAttribute) @@ -966,7 +966,7 @@ public TaskInfo updateDistinctAttributeSettings(String distinctAttribute) * @return TaskInfo instance * @throws MeilisearchException if an error occurs * @see API + * href="https://www.meilisearch.com/docs/reference/api/settings/list-all-settings#reset-distinct-attribute">API * specification */ public TaskInfo resetDistinctAttributeSettings() throws MeilisearchException { @@ -978,7 +978,7 @@ public TaskInfo resetDistinctAttributeSettings() throws MeilisearchException { * * @return TypoTolerance instance from Index * @throws MeilisearchException if an error occurs - * @see API + * @see API * specification */ public TypoTolerance getTypoToleranceSettings() throws MeilisearchException { @@ -992,7 +992,7 @@ public TypoTolerance getTypoToleranceSettings() throws MeilisearchException { * @return TaskInfo instance * @throws MeilisearchException if an error occurs * @see API + * href="https://www.meilisearch.com/docs/reference/api/settings/list-all-settings#update-typo-tolerance">API * specification */ public TaskInfo updateTypoToleranceSettings(TypoTolerance typoTolerance) @@ -1006,7 +1006,7 @@ public TaskInfo updateTypoToleranceSettings(TypoTolerance typoTolerance) * @return TaskInfo instance * @throws MeilisearchException if an error occurs * @see API + * href="https://www.meilisearch.com/docs/reference/api/settings/list-all-settings#reset-typo-tolerance">API * specification */ public TaskInfo resetTypoToleranceSettings() throws MeilisearchException { @@ -1019,7 +1019,7 @@ public TaskInfo resetTypoToleranceSettings() throws MeilisearchException { * @return Pagination instance from Index * @throws MeilisearchException if an error occurs * @see API + * href="https://www.meilisearch.com/docs/reference/api/settings/list-all-settings#get-pagination-settings">API * specification */ public Pagination getPaginationSettings() throws MeilisearchException { @@ -1033,7 +1033,7 @@ public Pagination getPaginationSettings() throws MeilisearchException { * @return TaskInfo instance * @throws MeilisearchException if an error occurs * @see API + * href="https://www.meilisearch.com/docs/reference/api/settings/list-all-settings#update-pagination-settings">API * specification */ public TaskInfo updatePaginationSettings(Pagination pagination) throws MeilisearchException { @@ -1046,7 +1046,7 @@ public TaskInfo updatePaginationSettings(Pagination pagination) throws Meilisear * @return TaskInfo instance * @throws MeilisearchException if an error occurs * @see API + * href="https://www.meilisearch.com/docs/reference/api/settings/list-all-settings#reset-pagination-settings">API * specification */ public TaskInfo resetPaginationSettings() throws MeilisearchException { @@ -1059,7 +1059,7 @@ public TaskInfo resetPaginationSettings() throws MeilisearchException { * @return Faceting instance from Index * @throws MeilisearchException if an error occurs * @see API + * href="https://www.meilisearch.com/docs/reference/api/settings/list-all-settings#get-faceting-settings">API * specification */ public Faceting getFacetingSettings() throws MeilisearchException { @@ -1073,7 +1073,7 @@ public Faceting getFacetingSettings() throws MeilisearchException { * @return TaskInfo instance * @throws MeilisearchException if an error occurs * @see API + * href="https://www.meilisearch.com/docs/reference/api/settings/list-all-settings#update-faceting-settings">API * specification */ public TaskInfo updateFacetingSettings(Faceting faceting) throws MeilisearchException { @@ -1086,7 +1086,7 @@ public TaskInfo updateFacetingSettings(Faceting faceting) throws MeilisearchExce * @return TaskInfo instance * @throws MeilisearchException if an error occurs * @see API + * href="https://www.meilisearch.com/docs/reference/api/settings/list-all-settings#reset-faceting-settings">API * specification */ public TaskInfo resetFacetingSettings() throws MeilisearchException { @@ -1098,7 +1098,7 @@ public TaskInfo resetFacetingSettings() throws MeilisearchException { * * @return dictionary of a given uid as String * @throws MeilisearchException if an error occurs - * @see API + * @see API * specification */ public String[] getDictionarySettings() throws MeilisearchException { @@ -1111,7 +1111,7 @@ public String[] getDictionarySettings() throws MeilisearchException { * @param dictionary An array of strings that contains the dictionary. * @return TaskInfo instance * @throws MeilisearchException if an error occurs - * @see API + * @see API * specification */ public TaskInfo updateDictionarySettings(String[] dictionary) throws MeilisearchException { @@ -1123,7 +1123,7 @@ public TaskInfo updateDictionarySettings(String[] dictionary) throws Meilisearch * * @return TaskInfo instance * @throws MeilisearchException if an error occurs - * @see API + * @see API * specification */ public TaskInfo resetDictionarySettings() throws MeilisearchException { @@ -1136,7 +1136,7 @@ public TaskInfo resetDictionarySettings() throws MeilisearchException { * @return separator tokens of a given uid as String * @throws MeilisearchException if an error occurs * @see API + * href="https://www.meilisearch.com/docs/reference/api/settings/list-all-settings#get-separator-tokens">API * specification */ public String[] getSeparatorTokensSettings() throws MeilisearchException { @@ -1150,7 +1150,7 @@ public String[] getSeparatorTokensSettings() throws MeilisearchException { * @return TaskInfo instance * @throws MeilisearchException if an error occurs * @see API + * href="https://www.meilisearch.com/docs/reference/api/settings/list-all-settings#update-separator-tokens">API * specification */ public TaskInfo updateSeparatorTokensSettings(String[] separatorTokens) @@ -1164,7 +1164,7 @@ public TaskInfo updateSeparatorTokensSettings(String[] separatorTokens) * @return TaskInfo instance * @throws MeilisearchException if an error occurs * @see API + * href="https://www.meilisearch.com/docs/reference/api/settings/list-all-settings#reset-separator-tokens">API * specification */ public TaskInfo resetSeparatorTokensSettings() throws MeilisearchException { @@ -1177,7 +1177,7 @@ public TaskInfo resetSeparatorTokensSettings() throws MeilisearchException { * @return non-separator tokens of a given uid as String * @throws MeilisearchException if an error occurs * @see API + * href="https://www.meilisearch.com/docs/reference/api/settings/list-all-settings#get-non-separator-tokens">API * specification */ public String[] getNonSeparatorTokensSettings() throws MeilisearchException { @@ -1191,7 +1191,7 @@ public String[] getNonSeparatorTokensSettings() throws MeilisearchException { * @return TaskInfo instance * @throws MeilisearchException if an error occurs * @see API + * href="https://www.meilisearch.com/docs/reference/api/settings/list-all-settings#update-non-separator-tokens">API * specification */ public TaskInfo updateNonSeparatorTokensSettings(String[] separatorTokens) @@ -1205,7 +1205,7 @@ public TaskInfo updateNonSeparatorTokensSettings(String[] separatorTokens) * @return TaskInfo instance * @throws MeilisearchException if an error occurs * @see API + * href="https://www.meilisearch.com/docs/reference/api/settings/list-all-settings#reset-non-separator-tokens">API * specification */ public TaskInfo resetNonSeparatorTokensSettings() throws MeilisearchException { @@ -1218,7 +1218,7 @@ public TaskInfo resetNonSeparatorTokensSettings() throws MeilisearchException { * @return proximity precision level of a given uid as String * @throws MeilisearchException if an error occurs * @see API + * href="https://www.meilisearch.com/docs/reference/api/settings/list-all-settings#get-proximity-precision-settings">API * specification */ public String getProximityPrecisionSettings() throws MeilisearchException { @@ -1232,7 +1232,7 @@ public String getProximityPrecisionSettings() throws MeilisearchException { * @return TaskInfo instance * @throws MeilisearchException if an error occurs * @see API + * href="https://www.meilisearch.com/docs/reference/api/settings/list-all-settings#update-proximity-precision-settings">API * specification */ public TaskInfo updateProximityPrecisionSettings(String proximityPrecision) @@ -1246,7 +1246,7 @@ public TaskInfo updateProximityPrecisionSettings(String proximityPrecision) * @return TaskInfo instance * @throws MeilisearchException if an error occurs * @see API + * href="https://www.meilisearch.com/docs/reference/api/settings/list-all-settings#reset-proximity-precision-settings">API * specification */ public TaskInfo resetProximityPrecisionSettings() throws MeilisearchException { @@ -1258,7 +1258,7 @@ public TaskInfo resetProximityPrecisionSettings() throws MeilisearchException { * * @return Meilisearch API response * @throws MeilisearchException if an error occurs - * @see API + * @see API * specification */ public IndexStats getStats() throws MeilisearchException { @@ -1271,7 +1271,7 @@ public IndexStats getStats() throws MeilisearchException { * @param taskId Identifier of the requested index task * @return Task instance * @throws MeilisearchException if an error occurs - * @see API + * @see API * specification */ public Task getTask(int taskId) throws MeilisearchException { @@ -1283,7 +1283,7 @@ public Task getTask(int taskId) throws MeilisearchException { * * @return List of tasks in the Meilisearch index * @throws MeilisearchException if an error occurs - * @see API + * @see API * specification */ public TasksResults getTasks() throws MeilisearchException { @@ -1296,7 +1296,7 @@ public TasksResults getTasks() throws MeilisearchException { * @param param accept by the tasks route * @return List of tasks in the Meilisearch index * @throws MeilisearchException if an error occurs - * @see API + * @see API * specification */ public TasksResults getTasks(TasksQuery param) throws MeilisearchException { @@ -1308,7 +1308,7 @@ public TasksResults getTasks(TasksQuery param) throws MeilisearchException { * * @param taskId Identifier of the requested Task * @throws MeilisearchException if an error occurs or if timeout is reached - * @see API + * @see API * specification */ public void waitForTask(int taskId) throws MeilisearchException { @@ -1322,7 +1322,7 @@ public void waitForTask(int taskId) throws MeilisearchException { * @param timeoutInMs number of milliseconds before throwing an Exception * @param intervalInMs number of milliseconds before requesting the status again * @throws MeilisearchException if an error occurs or if timeout is reached - * @see API + * @see API * specification */ public void waitForTask(int taskId, int timeoutInMs, int intervalInMs) @@ -1347,7 +1347,7 @@ public void fetchPrimaryKey() throws MeilisearchException { * * @return Integer search cutoff value in milliseconds * @throws MeilisearchException if an error occurs - * @see API + * @see API * specification */ public Integer getSearchCutoffMsSettings() throws MeilisearchException { @@ -1361,7 +1361,7 @@ public Integer getSearchCutoffMsSettings() throws MeilisearchException { * @return TaskInfo instance * @throws MeilisearchException if an error occurs * @see API + * href="https://www.meilisearch.com/docs/reference/api/settings/list-all-settings#update-search-cutoff">API * specification */ public TaskInfo updateSearchCutoffMsSettings(Integer milliseconds) throws MeilisearchException { @@ -1374,7 +1374,7 @@ public TaskInfo updateSearchCutoffMsSettings(Integer milliseconds) throws Meilis * @return TaskInfo instance * @throws MeilisearchException if an error occurs * @see API + * href="https://www.meilisearch.com/docs/reference/api/settings/list-all-settings#reset-search-cutoff">API * specification */ public TaskInfo resetSearchCutoffMsSettings() throws MeilisearchException { @@ -1387,7 +1387,7 @@ public TaskInfo resetSearchCutoffMsSettings() throws MeilisearchException { * @param query SimilarDocumentRequest containing parameters for the similar documents search * @return SimilarDocumentsResults containing the search results * @throws MeilisearchException if an error occurs - * @see API specification + * @see API specification */ public SimilarDocumentsResults searchSimilarDocuments(SimilarDocumentRequest query) throws MeilisearchException { @@ -1402,7 +1402,7 @@ public SimilarDocumentsResults searchSimilarDocuments(SimilarDocumentRequest que * * @return a Map that contains all embedders settings * @throws MeilisearchException if an error occurs - * @see API + * @see API * specification */ public Map getEmbeddersSettings() throws MeilisearchException { @@ -1415,7 +1415,7 @@ public Map getEmbeddersSettings() throws MeilisearchException * @param embedders a Map that contains the new embedders settings * @return TaskInfo instance * @throws MeilisearchException if an error occurs - * @see API + * @see API * specification */ public TaskInfo updateEmbeddersSettings(Map embedders) @@ -1428,7 +1428,7 @@ public TaskInfo updateEmbeddersSettings(Map embedders) * * @return TaskInfo instance * @throws MeilisearchException if an error occurs - * @see API + * @see API * specification */ public TaskInfo resetEmbeddersSettings() throws MeilisearchException { @@ -1440,7 +1440,7 @@ public TaskInfo resetEmbeddersSettings() throws MeilisearchException { * * @return TaskInfo instance * @throws MeilisearchException if an error occurs - * @see API specification + * @see API specification */ public TaskInfo compact() throws MeilisearchException { return this.config.httpClient.post( diff --git a/src/main/java/com/meilisearch/sdk/IndexesHandler.java b/src/main/java/com/meilisearch/sdk/IndexesHandler.java index 181af836..7ecaca82 100644 --- a/src/main/java/com/meilisearch/sdk/IndexesHandler.java +++ b/src/main/java/com/meilisearch/sdk/IndexesHandler.java @@ -10,7 +10,7 @@ /** * Class covering the Meilisearch Index API. * - * @see API specification + * @see API specification */ public class IndexesHandler { private final HttpClient httpClient; diff --git a/src/main/java/com/meilisearch/sdk/InstanceHandler.java b/src/main/java/com/meilisearch/sdk/InstanceHandler.java index eea457b5..672294af 100644 --- a/src/main/java/com/meilisearch/sdk/InstanceHandler.java +++ b/src/main/java/com/meilisearch/sdk/InstanceHandler.java @@ -22,7 +22,7 @@ protected InstanceHandler(Config config) { * * @return Meilisearch API response * @throws MeilisearchException if an error occurs - * @see API specification + * @see API specification */ String health() throws MeilisearchException { return httpClient.get("/health", String.class); @@ -33,7 +33,7 @@ String health() throws MeilisearchException { * * @return Meilisearch API response * @throws MeilisearchException if an error occurs - * @see API specification + * @see API specification */ boolean isHealthy() throws MeilisearchException { try { @@ -49,7 +49,7 @@ boolean isHealthy() throws MeilisearchException { * * @return Meilisearch API response * @throws MeilisearchException if an error occurs - * @see API specification + * @see API specification */ Stats getStats() throws MeilisearchException { return httpClient.get("/stats", Stats.class); @@ -61,7 +61,7 @@ Stats getStats() throws MeilisearchException { * @param uid Index identifier to the requested * @return Meilisearch API response * @throws MeilisearchException if an error occurs - * @see API specification + * @see API specification */ IndexStats getIndexStats(String uid) throws MeilisearchException { String requestQuery = "/indexes/" + uid + "/stats"; @@ -73,7 +73,7 @@ IndexStats getIndexStats(String uid) throws MeilisearchException { * * @return Meilisearch API response * @throws MeilisearchException if an error occurs - * @see API specification + * @see API specification */ String getVersion() throws MeilisearchException { return httpClient.get("/version", String.class); diff --git a/src/main/java/com/meilisearch/sdk/KeysHandler.java b/src/main/java/com/meilisearch/sdk/KeysHandler.java index c15d77d9..2f28cc82 100644 --- a/src/main/java/com/meilisearch/sdk/KeysHandler.java +++ b/src/main/java/com/meilisearch/sdk/KeysHandler.java @@ -10,7 +10,7 @@ /** * Class covering the Meilisearch Key API * - * @see API specification + * @see API specification */ public class KeysHandler { private final HttpClient httpClient; diff --git a/src/main/java/com/meilisearch/sdk/Search.java b/src/main/java/com/meilisearch/sdk/Search.java index 539aaa74..28318727 100644 --- a/src/main/java/com/meilisearch/sdk/Search.java +++ b/src/main/java/com/meilisearch/sdk/Search.java @@ -8,7 +8,7 @@ /** * Class used for searching on Meilisearch indexes * - * @see API specification + * @see API specification */ public class Search { private final HttpClient httpClient; diff --git a/src/main/java/com/meilisearch/sdk/SettingsHandler.java b/src/main/java/com/meilisearch/sdk/SettingsHandler.java index 1a20056b..6abfa82f 100644 --- a/src/main/java/com/meilisearch/sdk/SettingsHandler.java +++ b/src/main/java/com/meilisearch/sdk/SettingsHandler.java @@ -16,7 +16,7 @@ /** * Class covering the Meilisearch Settings API * - * @see API specification + * @see API specification * @see Settings */ public class SettingsHandler { diff --git a/src/main/java/com/meilisearch/sdk/TasksHandler.java b/src/main/java/com/meilisearch/sdk/TasksHandler.java index 3692d919..12be6791 100644 --- a/src/main/java/com/meilisearch/sdk/TasksHandler.java +++ b/src/main/java/com/meilisearch/sdk/TasksHandler.java @@ -11,7 +11,7 @@ /** * Class covering the Meilisearch Task API * - * @see API specification + * @see API specification */ public class TasksHandler { private final HttpClient httpClient; diff --git a/src/main/java/com/meilisearch/sdk/enums/OperationType.java b/src/main/java/com/meilisearch/sdk/enums/OperationType.java index fd26ace8..83fe14e8 100644 --- a/src/main/java/com/meilisearch/sdk/enums/OperationType.java +++ b/src/main/java/com/meilisearch/sdk/enums/OperationType.java @@ -6,7 +6,7 @@ /** * Enum for Operation Type * - * @see API specification + * @see API specification */ public enum OperationType { @SerializedName("indexCreation") diff --git a/src/main/java/com/meilisearch/sdk/model/CancelTasksQuery.java b/src/main/java/com/meilisearch/sdk/model/CancelTasksQuery.java index 12bf8ef1..c711829b 100644 --- a/src/main/java/com/meilisearch/sdk/model/CancelTasksQuery.java +++ b/src/main/java/com/meilisearch/sdk/model/CancelTasksQuery.java @@ -9,7 +9,7 @@ /** * Data structure of a query parameter for tasks route * - * @see API + * @see API * specification */ @Setter diff --git a/src/main/java/com/meilisearch/sdk/model/CreateUpdateWebhookRequest.java b/src/main/java/com/meilisearch/sdk/model/CreateUpdateWebhookRequest.java index 0d4b5851..2ebbb145 100644 --- a/src/main/java/com/meilisearch/sdk/model/CreateUpdateWebhookRequest.java +++ b/src/main/java/com/meilisearch/sdk/model/CreateUpdateWebhookRequest.java @@ -7,7 +7,7 @@ /** * Data structure used in request body while creating or updating a webhook. * - * @see API Specification + * @see API Specification */ public class CreateUpdateWebhookRequest implements Serializable { final String url; diff --git a/src/main/java/com/meilisearch/sdk/model/CursorResults.java b/src/main/java/com/meilisearch/sdk/model/CursorResults.java index 7557e25b..54753fc3 100644 --- a/src/main/java/com/meilisearch/sdk/model/CursorResults.java +++ b/src/main/java/com/meilisearch/sdk/model/CursorResults.java @@ -6,7 +6,7 @@ /** * Data structure paginated response Currently used in : Batches. * - * @see API + * @see API * specification */ @Data diff --git a/src/main/java/com/meilisearch/sdk/model/DeleteTasksQuery.java b/src/main/java/com/meilisearch/sdk/model/DeleteTasksQuery.java index 6a12a973..3c67063a 100644 --- a/src/main/java/com/meilisearch/sdk/model/DeleteTasksQuery.java +++ b/src/main/java/com/meilisearch/sdk/model/DeleteTasksQuery.java @@ -9,7 +9,7 @@ /** * Data structure of a query parameter for tasks route * - * @see API + * @see API * specification */ @Setter diff --git a/src/main/java/com/meilisearch/sdk/model/DocumentQuery.java b/src/main/java/com/meilisearch/sdk/model/DocumentQuery.java index 8dc74303..52da293e 100644 --- a/src/main/java/com/meilisearch/sdk/model/DocumentQuery.java +++ b/src/main/java/com/meilisearch/sdk/model/DocumentQuery.java @@ -7,7 +7,7 @@ /** * Data structure of the query parameters of the documents route when retrieving a document * - * @see API + * @see API * specification */ @Setter diff --git a/src/main/java/com/meilisearch/sdk/model/DocumentsQuery.java b/src/main/java/com/meilisearch/sdk/model/DocumentsQuery.java index 1718e9b2..c16cdea8 100644 --- a/src/main/java/com/meilisearch/sdk/model/DocumentsQuery.java +++ b/src/main/java/com/meilisearch/sdk/model/DocumentsQuery.java @@ -10,7 +10,7 @@ * Data structure of the query parameters or request body params of the documents route when * retrieving multiple documents * - * @see API + * @see API * specification */ @Setter diff --git a/src/main/java/com/meilisearch/sdk/model/FacetSearchResult.java b/src/main/java/com/meilisearch/sdk/model/FacetSearchResult.java index 53f2b1dd..e8bcfeb9 100644 --- a/src/main/java/com/meilisearch/sdk/model/FacetSearchResult.java +++ b/src/main/java/com/meilisearch/sdk/model/FacetSearchResult.java @@ -8,7 +8,7 @@ /** * Meilisearch facet search response data structure * - * @see API + * @see API * specification */ @Getter diff --git a/src/main/java/com/meilisearch/sdk/model/FacetSearchable.java b/src/main/java/com/meilisearch/sdk/model/FacetSearchable.java index 0f0ea2d3..b32e6955 100644 --- a/src/main/java/com/meilisearch/sdk/model/FacetSearchable.java +++ b/src/main/java/com/meilisearch/sdk/model/FacetSearchable.java @@ -6,7 +6,7 @@ /** * Meilisearch facet search response data structure * - * @see API specification + * @see API specification */ public interface FacetSearchable { ArrayList> getFacetHits(); diff --git a/src/main/java/com/meilisearch/sdk/model/FacetSortValue.java b/src/main/java/com/meilisearch/sdk/model/FacetSortValue.java index 9cbeaa6c..cafa7068 100644 --- a/src/main/java/com/meilisearch/sdk/model/FacetSortValue.java +++ b/src/main/java/com/meilisearch/sdk/model/FacetSortValue.java @@ -6,7 +6,7 @@ /** * Enum for Sorting Facet Values * - * @see API + * @see API * specification */ public enum FacetSortValue { diff --git a/src/main/java/com/meilisearch/sdk/model/IndexStats.java b/src/main/java/com/meilisearch/sdk/model/IndexStats.java index fffbded5..c1354a75 100644 --- a/src/main/java/com/meilisearch/sdk/model/IndexStats.java +++ b/src/main/java/com/meilisearch/sdk/model/IndexStats.java @@ -6,7 +6,7 @@ /** * Stats data structure of a Meilisearch Index * - * @see API + * @see API * specification */ @Getter diff --git a/src/main/java/com/meilisearch/sdk/model/IndexesQuery.java b/src/main/java/com/meilisearch/sdk/model/IndexesQuery.java index 7bbfee9f..5943f2bd 100644 --- a/src/main/java/com/meilisearch/sdk/model/IndexesQuery.java +++ b/src/main/java/com/meilisearch/sdk/model/IndexesQuery.java @@ -8,7 +8,7 @@ /** * Data structure of the query parameters when fetching indexes * - * @see API + * @see API * specification */ @Setter diff --git a/src/main/java/com/meilisearch/sdk/model/Key.java b/src/main/java/com/meilisearch/sdk/model/Key.java index 3d4576c9..cc273cd1 100644 --- a/src/main/java/com/meilisearch/sdk/model/Key.java +++ b/src/main/java/com/meilisearch/sdk/model/Key.java @@ -10,7 +10,7 @@ /** * Data structure of Meilisearch response for a Key * - * @see API specification + * @see API specification */ @Getter @Setter diff --git a/src/main/java/com/meilisearch/sdk/model/KeyUpdate.java b/src/main/java/com/meilisearch/sdk/model/KeyUpdate.java index b22c6582..38c3efea 100644 --- a/src/main/java/com/meilisearch/sdk/model/KeyUpdate.java +++ b/src/main/java/com/meilisearch/sdk/model/KeyUpdate.java @@ -7,7 +7,7 @@ /** * Data structure for updating a Key * - * @see API specification + * @see API specification */ @Getter public class KeyUpdate { diff --git a/src/main/java/com/meilisearch/sdk/model/KeysQuery.java b/src/main/java/com/meilisearch/sdk/model/KeysQuery.java index 11264fb6..1e7faaec 100644 --- a/src/main/java/com/meilisearch/sdk/model/KeysQuery.java +++ b/src/main/java/com/meilisearch/sdk/model/KeysQuery.java @@ -8,7 +8,7 @@ /** * Data structure of the query parameters for the keys routes * - * @see API + * @see API * specification */ @Setter diff --git a/src/main/java/com/meilisearch/sdk/model/LocalizedAttribute.java b/src/main/java/com/meilisearch/sdk/model/LocalizedAttribute.java index ba87a194..26ea293f 100644 --- a/src/main/java/com/meilisearch/sdk/model/LocalizedAttribute.java +++ b/src/main/java/com/meilisearch/sdk/model/LocalizedAttribute.java @@ -8,7 +8,7 @@ /** * LocalizedAttribute setting data structure * - * @see API + * @see API * specification */ @Getter diff --git a/src/main/java/com/meilisearch/sdk/model/MultiSearchResult.java b/src/main/java/com/meilisearch/sdk/model/MultiSearchResult.java index 66646754..1268dea1 100644 --- a/src/main/java/com/meilisearch/sdk/model/MultiSearchResult.java +++ b/src/main/java/com/meilisearch/sdk/model/MultiSearchResult.java @@ -8,7 +8,7 @@ /** * Multi search response * - *

https://www.meilisearch.com/docs/reference/api/multi_search#response + *

https://www.meilisearch.com/docs/reference/api/multi-search/perform-a-multi-search#response */ @Getter @ToString diff --git a/src/main/java/com/meilisearch/sdk/model/SearchResult.java b/src/main/java/com/meilisearch/sdk/model/SearchResult.java index 0640d4d2..3ce5ca2c 100644 --- a/src/main/java/com/meilisearch/sdk/model/SearchResult.java +++ b/src/main/java/com/meilisearch/sdk/model/SearchResult.java @@ -8,7 +8,7 @@ /** * Meilisearch search response data structure for infinite pagination * - * @see API + * @see API * specification */ @Getter diff --git a/src/main/java/com/meilisearch/sdk/model/SearchResultPaginated.java b/src/main/java/com/meilisearch/sdk/model/SearchResultPaginated.java index 474ba742..6acd0292 100644 --- a/src/main/java/com/meilisearch/sdk/model/SearchResultPaginated.java +++ b/src/main/java/com/meilisearch/sdk/model/SearchResultPaginated.java @@ -9,7 +9,7 @@ * Meilisearch search response data structure for limited pagination * * @see + * href="https://www.meilisearch.com/docs/guides/front_end/pagination#numbered-page-selectors"> * Numbered Page Selectors */ @Getter diff --git a/src/main/java/com/meilisearch/sdk/model/Searchable.java b/src/main/java/com/meilisearch/sdk/model/Searchable.java index 774d7a38..c7272386 100644 --- a/src/main/java/com/meilisearch/sdk/model/Searchable.java +++ b/src/main/java/com/meilisearch/sdk/model/Searchable.java @@ -6,7 +6,7 @@ /** * Meilisearch search common response data structure * - * @see API specification + * @see API specification */ public interface Searchable { ArrayList> getHits(); diff --git a/src/main/java/com/meilisearch/sdk/model/Settings.java b/src/main/java/com/meilisearch/sdk/model/Settings.java index 8b74c4d0..88313bfa 100644 --- a/src/main/java/com/meilisearch/sdk/model/Settings.java +++ b/src/main/java/com/meilisearch/sdk/model/Settings.java @@ -9,7 +9,7 @@ /** * Meilisearch settings data structure * - * @see API specification + * @see API specification */ @Getter @Setter diff --git a/src/main/java/com/meilisearch/sdk/model/SimilarDocumentsResults.java b/src/main/java/com/meilisearch/sdk/model/SimilarDocumentsResults.java index b64b8d10..86b82aa3 100644 --- a/src/main/java/com/meilisearch/sdk/model/SimilarDocumentsResults.java +++ b/src/main/java/com/meilisearch/sdk/model/SimilarDocumentsResults.java @@ -8,7 +8,7 @@ /** * Meilisearch similar documents results data structure * - * @see API + * @see API * specification */ @Getter diff --git a/src/main/java/com/meilisearch/sdk/model/Stats.java b/src/main/java/com/meilisearch/sdk/model/Stats.java index c43ce774..972c75dc 100644 --- a/src/main/java/com/meilisearch/sdk/model/Stats.java +++ b/src/main/java/com/meilisearch/sdk/model/Stats.java @@ -7,7 +7,7 @@ /** * Meilisearch stats data structure * - * @see API specification + * @see API specification */ @Getter public class Stats { diff --git a/src/main/java/com/meilisearch/sdk/model/Task.java b/src/main/java/com/meilisearch/sdk/model/Task.java index d2995e66..bbcdbb69 100644 --- a/src/main/java/com/meilisearch/sdk/model/Task.java +++ b/src/main/java/com/meilisearch/sdk/model/Task.java @@ -6,7 +6,7 @@ /** * Data structure of Meilisearch response for a Task * - * @see API specification + * @see API specification */ @Getter public class Task { diff --git a/src/main/java/com/meilisearch/sdk/model/TaskInfo.java b/src/main/java/com/meilisearch/sdk/model/TaskInfo.java index 6766ed22..468c0fe5 100644 --- a/src/main/java/com/meilisearch/sdk/model/TaskInfo.java +++ b/src/main/java/com/meilisearch/sdk/model/TaskInfo.java @@ -6,7 +6,7 @@ /** * Data structure of Meilisearch response for a asynchronous operation * - * @see API + * @see API * specification */ @Getter diff --git a/src/main/java/com/meilisearch/sdk/model/TaskStatus.java b/src/main/java/com/meilisearch/sdk/model/TaskStatus.java index e356fb59..e4743d0d 100644 --- a/src/main/java/com/meilisearch/sdk/model/TaskStatus.java +++ b/src/main/java/com/meilisearch/sdk/model/TaskStatus.java @@ -6,7 +6,7 @@ /** * Enum for Task Status * - * @see API specification + * @see API specification */ public enum TaskStatus { @SerializedName("enqueued") diff --git a/src/main/java/com/meilisearch/sdk/model/TasksQuery.java b/src/main/java/com/meilisearch/sdk/model/TasksQuery.java index 7391bd1a..70f45acd 100644 --- a/src/main/java/com/meilisearch/sdk/model/TasksQuery.java +++ b/src/main/java/com/meilisearch/sdk/model/TasksQuery.java @@ -9,7 +9,7 @@ /** * Data structure of a query parameter for tasks route * - * @see API + * @see API * specification */ @Setter diff --git a/src/main/java/com/meilisearch/sdk/model/TasksResults.java b/src/main/java/com/meilisearch/sdk/model/TasksResults.java index 1cc0dbd8..84e4c678 100644 --- a/src/main/java/com/meilisearch/sdk/model/TasksResults.java +++ b/src/main/java/com/meilisearch/sdk/model/TasksResults.java @@ -5,7 +5,7 @@ /** * Data structure of Meilisearch response for tasks Results * - * @see API + * @see API * specification */ @Getter diff --git a/src/main/java/com/meilisearch/sdk/model/TypoTolerance.java b/src/main/java/com/meilisearch/sdk/model/TypoTolerance.java index bbfc0ebf..907043e3 100644 --- a/src/main/java/com/meilisearch/sdk/model/TypoTolerance.java +++ b/src/main/java/com/meilisearch/sdk/model/TypoTolerance.java @@ -8,7 +8,7 @@ /** * Typo Tolerance setting data structure * - * @see API + * @see API * specification */ @Getter diff --git a/src/main/java/com/meilisearch/sdk/model/Webhook.java b/src/main/java/com/meilisearch/sdk/model/Webhook.java index ed832af9..42770bfe 100644 --- a/src/main/java/com/meilisearch/sdk/model/Webhook.java +++ b/src/main/java/com/meilisearch/sdk/model/Webhook.java @@ -8,7 +8,7 @@ /** * Webhook data structure. * - * @see API specification + * @see API specification */ public class Webhook implements Serializable { @Getter protected final UUID uuid; diff --git a/src/main/java/com/meilisearch/sdk/model/batch/req/BatchesQuery.java b/src/main/java/com/meilisearch/sdk/model/batch/req/BatchesQuery.java index cdd08988..814f32e5 100644 --- a/src/main/java/com/meilisearch/sdk/model/batch/req/BatchesQuery.java +++ b/src/main/java/com/meilisearch/sdk/model/batch/req/BatchesQuery.java @@ -8,7 +8,7 @@ /** * Data structure of a query parameter for batches route * - * @see API + * @see API * specification */ @Data diff --git a/src/main/java/com/meilisearch/sdk/model/batch/res/Batch.java b/src/main/java/com/meilisearch/sdk/model/batch/res/Batch.java index 9cf35584..31834689 100644 --- a/src/main/java/com/meilisearch/sdk/model/batch/res/Batch.java +++ b/src/main/java/com/meilisearch/sdk/model/batch/res/Batch.java @@ -6,7 +6,7 @@ /** * Data structure of the batch object response * - * @see API + * @see API * specification */ @Data