From 82d21fde9e59fcc29b67977883bef4ad61c05fae Mon Sep 17 00:00:00 2001 From: meili-bot <74670311+meili-bot@users.noreply.github.com> Date: Mon, 19 Jun 2023 21:56:32 -0300 Subject: [PATCH 01/11] Update README.tpl --- README.tpl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.tpl b/README.tpl index 9d5ce0e7..fe0b53cc 100644 --- a/README.tpl +++ b/README.tpl @@ -68,7 +68,7 @@ futures = "0.3" # To be able to block on async functions if you are not using an serde = { version = "1.0", features = ["derive"] } ``` -This crate is `async` but you can choose to use an async runtime like [tokio](https://crates.io/crates/tokio) or just [block on futures](https://docs.rs/futures/latest/futures/executor/fn.block_on.html). +This crate is `async` but you can choose to use an async runtime like [tokio](https://crates.io/crates/tokio) or just [block on futures](https://docs.rs/futures/latest/futures/executor/fn.block_on). You can enable the `sync` feature to make most structs `Sync`. It may be a bit slower. Using this crate is possible without [serde](https://crates.io/crates/serde), but a lot of features require serde. From 6b9481fd972b25307e3641a1891a337a4c6a45ad Mon Sep 17 00:00:00 2001 From: meili-bot <74670311+meili-bot@users.noreply.github.com> Date: Mon, 19 Jun 2023 21:56:33 -0300 Subject: [PATCH 02/11] Update src/client.rs --- src/client.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/client.rs b/src/client.rs index 89d338ed..a0472fd0 100644 --- a/src/client.rs +++ b/src/client.rs @@ -14,7 +14,7 @@ use crate::{ utils::async_sleep, }; -/// The top-level struct of the SDK, representing a client containing [indexes](../indexes/struct.Index.html). +/// The top-level struct of the SDK, representing a client containing [indexes](../indexes/struct.Index). #[derive(Debug, Clone)] pub struct Client { pub(crate) host: String, From f10956e2e6256df2201cd6590db34a05e065bd73 Mon Sep 17 00:00:00 2001 From: meili-bot <74670311+meili-bot@users.noreply.github.com> Date: Mon, 19 Jun 2023 21:56:33 -0300 Subject: [PATCH 03/11] Update src/documents.rs --- src/documents.rs | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/documents.rs b/src/documents.rs index 20d77a23..d2e6bba5 100644 --- a/src/documents.rs +++ b/src/documents.rs @@ -190,7 +190,7 @@ pub struct DocumentsQuery<'a> { /// Filters to apply. /// /// Available since v1.2 of Meilisearch - /// Read the [dedicated guide](https://docs.meilisearch.com/reference/features/filtering.html) to learn the syntax. + /// Read the [dedicated guide](https://www.meilisearch.com/docs/learn/fine_tuning_results/filtering#filter-basics) to learn the syntax. #[serde(skip_serializing_if = "Option::is_none")] pub filter: Option<&'a str>, } @@ -322,7 +322,7 @@ pub struct DocumentDeletionQuery<'a> { /// Filters to apply. /// - /// Read the [dedicated guide](https://docs.meilisearch.com/reference/features/filtering.html) to learn the syntax. + /// Read the [dedicated guide](https://www.meilisearch.com/docs/learn/fine_tuning_results/filtering#filter-basics) to learn the syntax. pub filter: Option<&'a str>, } @@ -579,7 +579,7 @@ mod tests { Hint: It might not be working because you're not up to date with the Meilisearch version that updated the get_documents_with method.".to_string(); let displayed_error = "Meilisearch invalid_request: invalid_document_filter: Attribute `id` is not filterable. This index does not have configured filterable attributes. 1:3 id = 1 -Hint: It might not be working because you're not up to date with the Meilisearch version that updated the get_documents_with method.. https://docs.meilisearch.com/errors#invalid_document_filter"; +Hint: It might not be working because you're not up to date with the Meilisearch version that updated the get_documents_with method.. https://www.meilisearch.com/docs/errors#invalid_document_filter"; match &error { Error::Meilisearch(error) => { From 1a5146ad077e90c572b97df68cc1fe476f585c56 Mon Sep 17 00:00:00 2001 From: meili-bot <74670311+meili-bot@users.noreply.github.com> Date: Mon, 19 Jun 2023 21:56:34 -0300 Subject: [PATCH 04/11] Update src/errors.rs --- src/errors.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/errors.rs b/src/errors.rs index e0d04026..909a9578 100644 --- a/src/errors.rs +++ b/src/errors.rs @@ -14,7 +14,7 @@ pub enum Error { #[error(transparent)] MeilisearchCommunication(#[from] MeilisearchCommunicationError), /// There is no Meilisearch server listening on the [specified host] - /// (../client/struct.Client.html#method.new). + /// (../client/struct.Client#method.new). #[error("The Meilisearch server can't be reached.")] UnreachableServer, /// The Meilisearch server returned an invalid JSON for a request. From 476ce7c7f81796fe7f64333bd5dbf39d9b2ada5e Mon Sep 17 00:00:00 2001 From: meili-bot <74670311+meili-bot@users.noreply.github.com> Date: Mon, 19 Jun 2023 21:56:35 -0300 Subject: [PATCH 05/11] Update src/search.rs --- src/search.rs | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/search.rs b/src/search.rs index 2115a0d0..6278d3ad 100644 --- a/src/search.rs +++ b/src/search.rs @@ -237,7 +237,7 @@ pub struct SearchQuery<'a> { pub filter: Option>, /// Facets for which to retrieve the matching count. /// - /// Can be set to a [wildcard value](enum.Selectors.html#variant.All) that will select all existing attributes. + /// Can be set to a [wildcard value](enum.Selectors#variant.All) that will select all existing attributes. /// /// **Default: all attributes found in the documents.** #[serde(skip_serializing_if = "Option::is_none")] @@ -248,7 +248,7 @@ pub struct SearchQuery<'a> { pub sort: Option<&'a [&'a str]>, /// Attributes to display in the returned documents. /// - /// Can be set to a [wildcard value](enum.Selectors.html#variant.All) that will select all existing attributes. + /// Can be set to a [wildcard value](enum.Selectors#variant.All) that will select all existing attributes. /// /// **Default: all attributes found in the documents.** #[serde(skip_serializing_if = "Option::is_none")] @@ -258,7 +258,7 @@ pub struct SearchQuery<'a> { /// /// Attributes are composed by the attribute name and an optional `usize` that overwrites the `crop_length` parameter. /// - /// Can be set to a [wildcard value](enum.Selectors.html#variant.All) that will select all existing attributes. + /// Can be set to a [wildcard value](enum.Selectors#variant.All) that will select all existing attributes. #[serde(skip_serializing_if = "Option::is_none")] #[serde(serialize_with = "serialize_attributes_to_crop_with_wildcard")] pub attributes_to_crop: Option]>>, @@ -278,7 +278,7 @@ pub struct SearchQuery<'a> { pub crop_marker: Option<&'a str>, /// Attributes whose values will contain **highlighted matching terms**. /// - /// Can be set to a [wildcard value](enum.Selectors.html#variant.All) that will select all existing attributes. + /// Can be set to a [wildcard value](enum.Selectors#variant.All) that will select all existing attributes. #[serde(skip_serializing_if = "Option::is_none")] #[serde(serialize_with = "serialize_with_wildcard")] pub attributes_to_highlight: Option>, From 614a6992972cdd9c89ee4ac98ec19a4120e1d0d2 Mon Sep 17 00:00:00 2001 From: meili-bot <74670311+meili-bot@users.noreply.github.com> Date: Mon, 19 Jun 2023 21:56:36 -0300 Subject: [PATCH 06/11] Update src/settings.rs --- src/settings.rs | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/src/settings.rs b/src/settings.rs index 67bf9344..61aca472 100644 --- a/src/settings.rs +++ b/src/settings.rs @@ -606,7 +606,7 @@ impl Index { .await } - /// Get [typo tolerance](https://docs.meilisearch.com/learn/configuration/typo_tolerance.html#typo-tolerance) of the [Index]. + /// Get [typo tolerance](https://www.meilisearch.com/docs/learn/configuration/typo_tolerance#typo-tolerance) of the [Index]. /// /// ``` /// # use meilisearch_sdk::{client::*, indexes::*}; @@ -1011,7 +1011,7 @@ impl Index { .await } - /// Update [displayed attributes](https://www.meilisearch.com/docs/reference/features/settings#displayed-attributes) of the [Index]. + /// Update [displayed attributes](https://www.meilisearch.com/docs/reference/api/settings#displayed-attributes) of the [Index]. /// /// # Example /// @@ -1091,7 +1091,7 @@ impl Index { .await } - /// Update [typo tolerance](https://docs.meilisearch.com/learn/configuration/typo_tolerance.html#typo-tolerance) settings of the [Index]. + /// Update [typo tolerance](https://www.meilisearch.com/docs/learn/configuration/typo_tolerance#typo-tolerance) settings of the [Index]. /// /// # Example /// @@ -1167,7 +1167,7 @@ impl Index { .await } - /// Reset [synonyms](https://www.meilisearch.com/docs/reference/features/synonyms.html) of the [Index]. + /// Reset [synonyms](https://www.meilisearch.com/docs/reference/api/settings#synonyms) of the [Index]. /// /// # Example /// @@ -1230,7 +1230,7 @@ impl Index { ) .await } - /// Reset [stop-words](https://www.meilisearch.com/docs/reference/features/stop_words.html) of the [Index]. + /// Reset [stop-words](https://www.meilisearch.com/docs/reference/api/settings#stop-words) of the [Index]. /// /// # Example /// @@ -1296,7 +1296,7 @@ impl Index { .await } - /// Reset [filterable attributes](https://www.meilisearch.com/docs/reference/features/filtering_and_faceted_search.html) of the [Index]. + /// Reset [filterable attributes](https://www.meilisearch.com/docs/reference/api/settings#filterable-attributes) of the [Index]. /// /// # Example /// @@ -1328,7 +1328,7 @@ impl Index { .await } - /// Reset [sortable attributes](https://www.meilisearch.com/docs/reference/features/sorting.html) of the [Index]. + /// Reset [sortable attributes](https://www.meilisearch.com/docs/reference/api/settings#sortable-attributes) of the [Index]. /// /// # Example /// @@ -1360,7 +1360,7 @@ impl Index { .await } - /// Reset the [distinct attribute](https://www.meilisearch.com/docs/reference/features/settings#distinct-attribute) of the [Index]. + /// Reset the [distinct attribute](https://www.meilisearch.com/docs/reference/api/settings#distinct-attribute) of the [Index]. /// /// # Example /// @@ -1392,7 +1392,7 @@ impl Index { .await } - /// Reset [searchable attributes](https://www.meilisearch.com/docs/reference/features/field_properties.html#searchable-fields) of + /// Reset [searchable attributes](https://www.meilisearch.com/docs/learn/configuration/displayed_searchable_attributes#searchable-fields) of /// the [Index] (enable all attributes). /// /// # Example @@ -1425,7 +1425,7 @@ impl Index { .await } - /// Reset [displayed attributes](https://www.meilisearch.com/docs/reference/features/settings#displayed-attributes) of the [Index] (enable all attributes). + /// Reset [displayed attributes](https://www.meilisearch.com/docs/reference/api/settings#displayed-attributes) of the [Index] (enable all attributes). /// /// # Example /// @@ -1489,7 +1489,7 @@ impl Index { .await } - /// Reset [typo tolerance](https://docs.meilisearch.com/learn/configuration/typo_tolerance.html#typo-tolerance) settings of the [Index]. + /// Reset [typo tolerance](https://www.meilisearch.com/docs/learn/configuration/typo_tolerance#typo-tolerance) settings of the [Index]. /// /// # Example /// From 5e4d0cf2a65228cfde9bb08f34a55bb3a37dec22 Mon Sep 17 00:00:00 2001 From: Bruno Casali Date: Mon, 19 Jun 2023 21:57:20 -0300 Subject: [PATCH 07/11] Update README.tpl --- README.tpl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.tpl b/README.tpl index fe0b53cc..9d5ce0e7 100644 --- a/README.tpl +++ b/README.tpl @@ -68,7 +68,7 @@ futures = "0.3" # To be able to block on async functions if you are not using an serde = { version = "1.0", features = ["derive"] } ``` -This crate is `async` but you can choose to use an async runtime like [tokio](https://crates.io/crates/tokio) or just [block on futures](https://docs.rs/futures/latest/futures/executor/fn.block_on). +This crate is `async` but you can choose to use an async runtime like [tokio](https://crates.io/crates/tokio) or just [block on futures](https://docs.rs/futures/latest/futures/executor/fn.block_on.html). You can enable the `sync` feature to make most structs `Sync`. It may be a bit slower. Using this crate is possible without [serde](https://crates.io/crates/serde), but a lot of features require serde. From c1d65595a6294b95dd4011667d96d84729f81e36 Mon Sep 17 00:00:00 2001 From: Bruno Casali Date: Mon, 19 Jun 2023 21:57:35 -0300 Subject: [PATCH 08/11] Update client.rs --- src/client.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/client.rs b/src/client.rs index a0472fd0..89d338ed 100644 --- a/src/client.rs +++ b/src/client.rs @@ -14,7 +14,7 @@ use crate::{ utils::async_sleep, }; -/// The top-level struct of the SDK, representing a client containing [indexes](../indexes/struct.Index). +/// The top-level struct of the SDK, representing a client containing [indexes](../indexes/struct.Index.html). #[derive(Debug, Clone)] pub struct Client { pub(crate) host: String, From 6229e7519281390e3d7554f6bbf8024365a01125 Mon Sep 17 00:00:00 2001 From: Bruno Casali Date: Mon, 19 Jun 2023 21:58:19 -0300 Subject: [PATCH 09/11] Update errors.rs --- src/errors.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/errors.rs b/src/errors.rs index 909a9578..e0d04026 100644 --- a/src/errors.rs +++ b/src/errors.rs @@ -14,7 +14,7 @@ pub enum Error { #[error(transparent)] MeilisearchCommunication(#[from] MeilisearchCommunicationError), /// There is no Meilisearch server listening on the [specified host] - /// (../client/struct.Client#method.new). + /// (../client/struct.Client.html#method.new). #[error("The Meilisearch server can't be reached.")] UnreachableServer, /// The Meilisearch server returned an invalid JSON for a request. From 6d15ae64f43cc15fcc2234de5040c956c9dd51b3 Mon Sep 17 00:00:00 2001 From: Bruno Casali Date: Mon, 19 Jun 2023 21:59:13 -0300 Subject: [PATCH 10/11] Update search.rs --- src/search.rs | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/search.rs b/src/search.rs index 6278d3ad..2115a0d0 100644 --- a/src/search.rs +++ b/src/search.rs @@ -237,7 +237,7 @@ pub struct SearchQuery<'a> { pub filter: Option>, /// Facets for which to retrieve the matching count. /// - /// Can be set to a [wildcard value](enum.Selectors#variant.All) that will select all existing attributes. + /// Can be set to a [wildcard value](enum.Selectors.html#variant.All) that will select all existing attributes. /// /// **Default: all attributes found in the documents.** #[serde(skip_serializing_if = "Option::is_none")] @@ -248,7 +248,7 @@ pub struct SearchQuery<'a> { pub sort: Option<&'a [&'a str]>, /// Attributes to display in the returned documents. /// - /// Can be set to a [wildcard value](enum.Selectors#variant.All) that will select all existing attributes. + /// Can be set to a [wildcard value](enum.Selectors.html#variant.All) that will select all existing attributes. /// /// **Default: all attributes found in the documents.** #[serde(skip_serializing_if = "Option::is_none")] @@ -258,7 +258,7 @@ pub struct SearchQuery<'a> { /// /// Attributes are composed by the attribute name and an optional `usize` that overwrites the `crop_length` parameter. /// - /// Can be set to a [wildcard value](enum.Selectors#variant.All) that will select all existing attributes. + /// Can be set to a [wildcard value](enum.Selectors.html#variant.All) that will select all existing attributes. #[serde(skip_serializing_if = "Option::is_none")] #[serde(serialize_with = "serialize_attributes_to_crop_with_wildcard")] pub attributes_to_crop: Option]>>, @@ -278,7 +278,7 @@ pub struct SearchQuery<'a> { pub crop_marker: Option<&'a str>, /// Attributes whose values will contain **highlighted matching terms**. /// - /// Can be set to a [wildcard value](enum.Selectors#variant.All) that will select all existing attributes. + /// Can be set to a [wildcard value](enum.Selectors.html#variant.All) that will select all existing attributes. #[serde(skip_serializing_if = "Option::is_none")] #[serde(serialize_with = "serialize_with_wildcard")] pub attributes_to_highlight: Option>, From 3f1e71b49174b4a28141408e1e898a7e1f5c36b3 Mon Sep 17 00:00:00 2001 From: cvermand <33010418+bidoubiwa@users.noreply.github.com> Date: Tue, 18 Jul 2023 14:04:55 +0200 Subject: [PATCH 11/11] Update src/documents.rs --- src/documents.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/documents.rs b/src/documents.rs index d2e6bba5..f2ff6869 100644 --- a/src/documents.rs +++ b/src/documents.rs @@ -579,7 +579,7 @@ mod tests { Hint: It might not be working because you're not up to date with the Meilisearch version that updated the get_documents_with method.".to_string(); let displayed_error = "Meilisearch invalid_request: invalid_document_filter: Attribute `id` is not filterable. This index does not have configured filterable attributes. 1:3 id = 1 -Hint: It might not be working because you're not up to date with the Meilisearch version that updated the get_documents_with method.. https://www.meilisearch.com/docs/errors#invalid_document_filter"; +Hint: It might not be working because you're not up to date with the Meilisearch version that updated the get_documents_with method.. https://docs.meilisearch.com/errors#invalid_document_filter"; match &error { Error::Meilisearch(error) => {