Skip to content

Commit 9fe431e

Browse files
authored
Update docs link (#105)
1 parent 5b054d1 commit 9fe431e

File tree

3 files changed

+61
-61
lines changed

3 files changed

+61
-61
lines changed

src/client.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ pub struct Client<'a> {
1313
impl<'a> Client<'a> {
1414
/// Create a client using the specified server.
1515
/// Don't put a '/' at the end of the host.
16-
/// In production mode, see [the documentation about authentication](https://docs.meilisearch.com/guides/advanced_guides/authentication.html#authentication).
16+
/// In production mode, see [the documentation about authentication](https://docs.meilisearch.com/reference/features/authentication.html#authentication).
1717
/// # Example
1818
///
1919
/// ```
@@ -207,12 +207,12 @@ impl<'a> Client<'a> {
207207
}
208208

209209
/// Get the private and public key.
210-
///
210+
///
211211
/// # Example
212-
///
212+
///
213213
/// ```
214214
/// # use meilisearch_sdk::{client::*, errors::Error};
215-
/// #
215+
/// #
216216
/// # futures::executor::block_on(async move {
217217
/// let client = Client::new("http://localhost:7700", "masterKey");
218218
/// let keys = client.get_keys().await.unwrap();

src/search.rs

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ pub struct MatchRange {
88
length: usize,
99
}
1010

11-
/// A single result.
11+
/// A single result.
1212
/// Contains the complete object, optionally the formatted object, and optionally an object that contains information about the matches.
1313
#[derive(Deserialize, Debug)]
1414
pub struct SearchResult<T> {
@@ -95,7 +95,7 @@ type AttributeToCrop<'a> = (&'a str, Option<usize>);
9595

9696
/// A struct representing a query.
9797
/// You can add search parameters using the builder syntax.
98-
/// See [this page](https://docs.meilisearch.com/guides/advanced_guides/search_parameters.html#query-q) for the official list and description of all parameters.
98+
/// See [this page](https://docs.meilisearch.com/reference/features/search_parameters.html#query-q) for the official list and description of all parameters.
9999
///
100100
/// # Examples
101101
///
@@ -125,68 +125,68 @@ type AttributeToCrop<'a> = (&'a str, Option<usize>);
125125
pub struct Query<'a> {
126126
#[serde(skip_serializing)]
127127
index: &'a Index<'a>,
128-
/// The text that will be searched for among the documents.
128+
/// The text that will be searched for among the documents.
129129
#[serde(skip_serializing_if = "Option::is_none")]
130130
#[serde(rename = "q")]
131131
pub query: Option<&'a str>,
132-
/// The number of documents to skip.
133-
/// If the value of the parameter `offset` is `n`, the `n` first documents (ordered by relevance) will not be returned.
134-
/// This is helpful for pagination.
135-
///
136-
/// Example: If you want to skip the first document, set offset to `1`.
132+
/// The number of documents to skip.
133+
/// If the value of the parameter `offset` is `n`, the `n` first documents (ordered by relevance) will not be returned.
134+
/// This is helpful for pagination.
135+
///
136+
/// Example: If you want to skip the first document, set offset to `1`.
137137
#[serde(skip_serializing_if = "Option::is_none")]
138138
pub offset: Option<usize>,
139-
/// The maximum number of documents returned.
140-
/// If the value of the parameter `limit` is `n`, there will never be more than `n` documents in the response.
141-
/// This is helpful for pagination.
142-
///
143-
/// Example: If you don't want to get more than two documents, set limit to `2`.
144-
/// Default: `20`
139+
/// The maximum number of documents returned.
140+
/// If the value of the parameter `limit` is `n`, there will never be more than `n` documents in the response.
141+
/// This is helpful for pagination.
142+
///
143+
/// Example: If you don't want to get more than two documents, set limit to `2`.
144+
/// Default: `20`
145145
#[serde(skip_serializing_if = "Option::is_none")]
146146
pub limit: Option<usize>,
147-
/// Filters applied to documents.
148-
/// Read the [dedicated guide](https://docs.meilisearch.com/guides/advanced_guides/filtering.html) to learn the syntax.
147+
/// Filters applied to documents.
148+
/// Read the [dedicated guide](https://docs.meilisearch.com/reference/features/filtering.html) to learn the syntax.
149149
#[serde(skip_serializing_if = "Option::is_none")]
150150
pub filters: Option<&'a str>,
151-
/// Facet names and values to filter on.
152-
/// Read [this page](https://docs.meilisearch.com/guides/advanced_guides/search_parameters.html#facet-filters) for a complete explanation.
151+
/// Facet names and values to filter on.
152+
/// Read [this page](https://docs.meilisearch.com/reference/features/search_parameters.html#facet-filters) for a complete explanation.
153153
#[serde(skip_serializing_if = "Option::is_none")]
154154
pub facet_filters: Option<&'a [&'a [&'a str]]>,
155-
/// Facets for which to retrieve the matching count.
156-
///
157-
/// Can be set to a [wildcard value](enum.Selectors.html#variant.All) that will select all existing attributes.
155+
/// Facets for which to retrieve the matching count.
156+
///
157+
/// Can be set to a [wildcard value](enum.Selectors.html#variant.All) that will select all existing attributes.
158158
/// Default: all attributes found in the documents.
159159
#[serde(skip_serializing_if = "Option::is_none")]
160160
#[serde(serialize_with = "serialize_with_wildcard")]
161161
pub facets_distribution: Option<Selectors<&'a [&'a str]>>,
162-
/// Attributes to display in the returned documents.
163-
///
164-
/// Can be set to a [wildcard value](enum.Selectors.html#variant.All) that will select all existing attributes.
162+
/// Attributes to display in the returned documents.
163+
///
164+
/// Can be set to a [wildcard value](enum.Selectors.html#variant.All) that will select all existing attributes.
165165
/// Default: all attributes found in the documents.
166166
#[serde(skip_serializing_if = "Option::is_none")]
167167
#[serde(serialize_with = "serialize_with_wildcard")]
168168
pub attributes_to_retrieve: Option<Selectors<&'a [&'a str]>>,
169-
/// Attributes whose values have to be cropped.
170-
/// Attributes are composed by the attribute name and an optional `usize` that overwrites the `crop_length` parameter.
171-
///
169+
/// Attributes whose values have to be cropped.
170+
/// Attributes are composed by the attribute name and an optional `usize` that overwrites the `crop_length` parameter.
171+
///
172172
/// Can be set to a [wildcard value](enum.Selectors.html#variant.All) that will select all existing attributes.
173173
#[serde(skip_serializing_if = "Option::is_none")]
174174
#[serde(serialize_with = "serialize_attributes_to_crop_with_wildcard")]
175175
pub attributes_to_crop: Option<Selectors<&'a [AttributeToCrop<'a>]>>,
176-
/// Number of characters to keep on each side of the start of the matching word.
177-
/// See [attributes_to_crop](#structfield.attributes_to_crop).
178-
///
176+
/// Number of characters to keep on each side of the start of the matching word.
177+
/// See [attributes_to_crop](#structfield.attributes_to_crop).
178+
///
179179
/// Default: `200`
180180
#[serde(skip_serializing_if = "Option::is_none")]
181181
pub crop_length: Option<usize>,
182-
/// Attributes whose values will contain **highlighted matching terms**.
183-
///
182+
/// Attributes whose values will contain **highlighted matching terms**.
183+
///
184184
/// Can be set to a [wildcard value](enum.Selectors.html#variant.All) that will select all existing attributes.
185185
#[serde(skip_serializing_if = "Option::is_none")]
186186
#[serde(serialize_with = "serialize_with_wildcard")]
187187
pub attributes_to_highlight: Option<Selectors<&'a [&'a str]>>,
188188
/// Defines whether an object that contains information about the matches should be returned or not.
189-
///
189+
///
190190
/// Default: `false`
191191
#[serde(skip_serializing_if = "Option::is_none")]
192192
pub matches: Option<bool>,

src/settings.rs

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,10 @@ pub struct Settings {
3535
/// List of words ignored by MeiliSearch when present in search queries
3636
#[serde(skip_serializing_if = "Option::is_none")]
3737
pub stop_words: Option<Vec<String>>,
38-
/// List of [ranking rules](https://docs.meilisearch.com/guides/main_concepts/relevancy.html#order-of-the-rules) sorted by order of importance
38+
/// List of [ranking rules](https://docs.meilisearch.com/learn/core_concepts/relevancy.html#order-of-the-rules) sorted by order of importance
3939
#[serde(skip_serializing_if = "Option::is_none")]
4040
pub ranking_rules: Option<Vec<String>>,
41-
/// Attributes to use as [facets](https://docs.meilisearch.com/guides/advanced_guides/faceted_search.html)
41+
/// Attributes to use as [facets](https://docs.meilisearch.com/reference/features/faceted_search.html)
4242
#[serde(skip_serializing_if = "Option::is_none")]
4343
pub attributes_for_faceting: Option<Vec<String>>,
4444
/// Search returns documents with distinct (different) values of the given field
@@ -130,7 +130,7 @@ impl<'a> Index<'a> {
130130
).await?)
131131
}
132132

133-
/// Get [synonyms](https://docs.meilisearch.com/guides/advanced_guides/synonyms.html) of the Index.
133+
/// Get [synonyms](https://docs.meilisearch.com/reference/features/synonyms.html) of the Index.
134134
///
135135
/// ```
136136
/// # use meilisearch_sdk::{client::*, indexes::*, document::*};
@@ -149,7 +149,7 @@ impl<'a> Index<'a> {
149149
).await?)
150150
}
151151

152-
/// Get [stop-words](https://docs.meilisearch.com/guides/advanced_guides/stop_words.html) of the Index.
152+
/// Get [stop-words](https://docs.meilisearch.com/reference/features/stop_words.html) of the Index.
153153
///
154154
/// ```
155155
/// # use meilisearch_sdk::{client::*, indexes::*, document::*};
@@ -168,7 +168,7 @@ impl<'a> Index<'a> {
168168
).await?)
169169
}
170170

171-
/// Get [ranking rules](https://docs.meilisearch.com/guides/main_concepts/relevancy.html#ranking-rules) of the Index.
171+
/// Get [ranking rules](https://docs.meilisearch.com/learn/core_concepts/relevancy.html#ranking-rules) of the Index.
172172
///
173173
/// ```
174174
/// # use meilisearch_sdk::{client::*, indexes::*, document::*};
@@ -187,7 +187,7 @@ impl<'a> Index<'a> {
187187
).await?)
188188
}
189189

190-
/// Get [attributes for faceting](https://docs.meilisearch.com/guides/advanced_guides/faceted_search.html) of the Index.
190+
/// Get [attributes for faceting](https://docs.meilisearch.com/reference/features/faceted_search.html) of the Index.
191191
///
192192
/// ```
193193
/// # use meilisearch_sdk::{client::*, indexes::*, document::*};
@@ -206,7 +206,7 @@ impl<'a> Index<'a> {
206206
).await?)
207207
}
208208

209-
/// Get the [distinct attribute](https://docs.meilisearch.com/guides/advanced_guides/settings.html#distinct-attribute) of the Index.
209+
/// Get the [distinct attribute](https://docs.meilisearch.com/reference/features/settings.html#distinct-attribute) of the Index.
210210
///
211211
/// ```
212212
/// # use meilisearch_sdk::{client::*, indexes::*, document::*};
@@ -225,7 +225,7 @@ impl<'a> Index<'a> {
225225
).await?)
226226
}
227227

228-
/// Get [searchable attributes](https://docs.meilisearch.com/guides/advanced_guides/field_properties.html#searchable-fields) of the Index.
228+
/// Get [searchable attributes](https://docs.meilisearch.com/reference/features/field_properties.html#searchable-fields) of the Index.
229229
///
230230
/// ```
231231
/// # use meilisearch_sdk::{client::*, indexes::*, document::*};
@@ -244,7 +244,7 @@ impl<'a> Index<'a> {
244244
).await?)
245245
}
246246

247-
/// Get [displayed attributes](https://docs.meilisearch.com/guides/advanced_guides/settings.html#displayed-attributes) of the Index.
247+
/// Get [displayed attributes](https://docs.meilisearch.com/reference/features/settings.html#displayed-attributes) of the Index.
248248
///
249249
/// ```
250250
/// # use meilisearch_sdk::{client::*, indexes::*, document::*};
@@ -291,7 +291,7 @@ impl<'a> Index<'a> {
291291
.into_progress(self))
292292
}
293293

294-
/// Update [synonyms](https://docs.meilisearch.com/guides/advanced_guides/synonyms.html) of the index.
294+
/// Update [synonyms](https://docs.meilisearch.com/reference/features/synonyms.html) of the index.
295295
///
296296
/// # Example
297297
///
@@ -319,7 +319,7 @@ impl<'a> Index<'a> {
319319
.into_progress(self))
320320
}
321321

322-
/// Update [stop-words](https://docs.meilisearch.com/guides/advanced_guides/stop_words.html) of the index.
322+
/// Update [stop-words](https://docs.meilisearch.com/reference/features/stop_words.html) of the index.
323323
///
324324
/// # Example
325325
///
@@ -343,7 +343,7 @@ impl<'a> Index<'a> {
343343
.into_progress(self))
344344
}
345345

346-
/// Update [ranking rules](https://docs.meilisearch.com/guides/main_concepts/relevancy.html#ranking-rules) of the index.
346+
/// Update [ranking rules](https://docs.meilisearch.com/learn/core_concepts/relevancy.html#ranking-rules) of the index.
347347
///
348348
/// # Example
349349
///
@@ -376,7 +376,7 @@ impl<'a> Index<'a> {
376376
.into_progress(self))
377377
}
378378

379-
/// Update [attributes for faceting](https://docs.meilisearch.com/guides/advanced_guides/faceted_search.html) of the index.
379+
/// Update [attributes for faceting](https://docs.meilisearch.com/reference/features/faceted_search.html) of the index.
380380
///
381381
/// # Example
382382
///
@@ -400,7 +400,7 @@ impl<'a> Index<'a> {
400400
.into_progress(self))
401401
}
402402

403-
/// Update the [distinct attribute](https://docs.meilisearch.com/guides/advanced_guides/settings.html#distinct-attribute) of the index.
403+
/// Update the [distinct attribute](https://docs.meilisearch.com/reference/features/settings.html#distinct-attribute) of the index.
404404
///
405405
/// # Example
406406
///
@@ -423,7 +423,7 @@ impl<'a> Index<'a> {
423423
.into_progress(self))
424424
}
425425

426-
/// Update [searchable attributes](https://docs.meilisearch.com/guides/advanced_guides/field_properties.html#searchable-fields) of the index.
426+
/// Update [searchable attributes](https://docs.meilisearch.com/reference/features/field_properties.html#searchable-fields) of the index.
427427
///
428428
/// # Example
429429
///
@@ -446,7 +446,7 @@ impl<'a> Index<'a> {
446446
.into_progress(self))
447447
}
448448

449-
/// Update [displayed attributes](https://docs.meilisearch.com/guides/advanced_guides/settings.html#displayed-attributes) of the index.
449+
/// Update [displayed attributes](https://docs.meilisearch.com/reference/features/settings.html#displayed-attributes) of the index.
450450
///
451451
/// # Example
452452
///
@@ -470,7 +470,7 @@ impl<'a> Index<'a> {
470470
}
471471

472472
/// Reset [settings](../settings/struct.Settings.html) of the index.
473-
/// All settings will be reset to their [default value](https://docs.meilisearch.com/references/settings.html#reset-settings).
473+
/// All settings will be reset to their [default value](https://docs.meilisearch.com/reference/api/settings.html#reset-settings).
474474
///
475475
/// # Example
476476
///
@@ -493,7 +493,7 @@ impl<'a> Index<'a> {
493493
.into_progress(self))
494494
}
495495

496-
/// Reset [synonyms](https://docs.meilisearch.com/guides/advanced_guides/synonyms.html) of the index.
496+
/// Reset [synonyms](https://docs.meilisearch.com/reference/features/synonyms.html) of the index.
497497
///
498498
/// # Example
499499
///
@@ -516,7 +516,7 @@ impl<'a> Index<'a> {
516516
.into_progress(self))
517517
}
518518

519-
/// Reset [stop-words](https://docs.meilisearch.com/guides/advanced_guides/stop_words.html) of the index.
519+
/// Reset [stop-words](https://docs.meilisearch.com/reference/features/stop_words.html) of the index.
520520
///
521521
/// # Example
522522
///
@@ -539,7 +539,7 @@ impl<'a> Index<'a> {
539539
.into_progress(self))
540540
}
541541

542-
/// Reset [ranking rules](https://docs.meilisearch.com/guides/main_concepts/relevancy.html#ranking-rules) of the index to default value.
542+
/// Reset [ranking rules](https://docs.meilisearch.com/learn/core_concepts/relevancy.html#ranking-rules) of the index to default value.
543543
/// Default value: ["typo", "words", "proximity", "attribute", "wordsPosition", "exactness"].
544544
///
545545
/// # Example
@@ -563,7 +563,7 @@ impl<'a> Index<'a> {
563563
.into_progress(self))
564564
}
565565

566-
/// Reset [attributes for faceting](https://docs.meilisearch.com/guides/advanced_guides/faceted_search.html) of the index.
566+
/// Reset [attributes for faceting](https://docs.meilisearch.com/reference/features/faceted_search.html) of the index.
567567
///
568568
/// # Example
569569
///
@@ -586,7 +586,7 @@ impl<'a> Index<'a> {
586586
.into_progress(self))
587587
}
588588

589-
/// Reset the [distinct attribute](https://docs.meilisearch.com/guides/advanced_guides/settings.html#distinct-attribute) of the index.
589+
/// Reset the [distinct attribute](https://docs.meilisearch.com/reference/features/settings.html#distinct-attribute) of the index.
590590
///
591591
/// # Example
592592
///
@@ -609,7 +609,7 @@ impl<'a> Index<'a> {
609609
.into_progress(self))
610610
}
611611

612-
/// Reset [searchable attributes](https://docs.meilisearch.com/guides/advanced_guides/field_properties.html#searchable-fields) of the index (enable all attributes).
612+
/// Reset [searchable attributes](https://docs.meilisearch.com/reference/features/field_properties.html#searchable-fields) of the index (enable all attributes).
613613
///
614614
/// # Example
615615
///
@@ -632,7 +632,7 @@ impl<'a> Index<'a> {
632632
.into_progress(self))
633633
}
634634

635-
/// Reset [displayed attributes](https://docs.meilisearch.com/guides/advanced_guides/settings.html#displayed-attributes) of the index (enable all attributes).
635+
/// Reset [displayed attributes](https://docs.meilisearch.com/reference/features/settings.html#displayed-attributes) of the index (enable all attributes).
636636
///
637637
/// # Example
638638
///

0 commit comments

Comments
 (0)