Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .code-samples.meilisearch.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -843,7 +843,7 @@ add_movies_json_1: |-
use futures::executor::block_on;

fn main() { block_on(async move {
let client = Client::new("MEILISEARCH_URL", Some("masterKey"));
let client = Client::new("MEILISEARCH_URL", Some("MEILISEARCH_KEY"));

// reading and parsing the file
let mut file = File::open("movies.json")
Expand Down Expand Up @@ -1188,7 +1188,7 @@ delete_a_key_1: |-
.delete_key(&key)
.await?;
authorization_header_1:
let client = Client::new("MEILISEARCH_URL", Some("MASTER_KEY"));
let client = Client::new("MEILISEARCH_URL", Some("MEILISEARCH_KEY"));
let keys = client
.get_keys()
.await
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<a href="https://discord.meilisearch.com">Discord</a> |
<a href="https://roadmap.meilisearch.com/tabs/1-under-consideration">Roadmap</a> |
<a href="https://www.meilisearch.com">Website</a> |
<a href="https://www.meilisearch.com/docs/faq">FAQ</a>
<a href="https://www.meilisearch.com/docs/learn/resources/faq">FAQ</a>
</h4>

<p align="center">
Expand Down Expand Up @@ -111,7 +111,7 @@ async fn main() {
}
```

With the `uid`, you can check the status (`enqueued`, `canceled`, `processing`, `succeeded` or `failed`) of your documents addition using the [task](https://www.meilisearch.com/docs/reference/api/tasks#get-task).
With the `uid`, you can check the status (`enqueued`, `canceled`, `processing`, `succeeded` or `failed`) of your documents addition using the [task](https://www.meilisearch.com/docs/reference/api/async-task-management/list-tasks#get-task).

#### Basic Search <!-- omit in TOC -->

Expand Down Expand Up @@ -189,7 +189,7 @@ client.index("movies_4").set_filterable_attributes(&filterable_attributes).await

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 [tasks](https://www.meilisearch.com/docs/reference/api/tasks#get-task).
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 [tasks](https://www.meilisearch.com/docs/reference/api/async-task-management/list-tasks#get-task).

Then, you can perform the search:

Expand Down
2 changes: 1 addition & 1 deletion README.tpl
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<a href="https://discord.meilisearch.com">Discord</a> |
<a href="https://roadmap.meilisearch.com/tabs/1-under-consideration">Roadmap</a> |
<a href="https://www.meilisearch.com">Website</a> |
<a href="https://www.meilisearch.com/docs/faq">FAQ</a>
<a href="https://www.meilisearch.com/docs/learn/resources/faq">FAQ</a>
</h4>

<p align="center">
Expand Down
2 changes: 1 addition & 1 deletion examples/settings.rs
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ async fn main() {
.expect("An error happened with the index creation.");

// And now we can update the settings!
// You can read more about the available options here: https://www.meilisearch.com/docs/learn/configuration/settings#index-settings
// You can read more about the available options here: https://www.meilisearch.com/docs/learn/configuration/configuring_index_settings#index-settings
let settings: Settings = Settings::new()
.with_searchable_attributes(["name", "title"])
.with_filterable_attributes(["created_at"]);
Expand Down
2 changes: 1 addition & 1 deletion src/batches.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ use crate::{client::Client, errors::Error, request::HttpClient};

/// Types and queries for the Meilisearch Batches API.
///
/// See: https://www.meilisearch.com/docs/reference/api/batches
/// See: https://www.meilisearch.com/docs/reference/api/async-task-management/list-batches
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Batch {
Expand Down
16 changes: 8 additions & 8 deletions src/client.rs
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ impl Client {
///
/// Don't put a '/' at the end of the host.
///
/// In production mode, see [the documentation about authentication](https://www.meilisearch.com/docs/learn/security/master_api_keys#authentication).
/// In production mode, see [the documentation about authentication](https://www.meilisearch.com/docs/learn/security/basic_security#authentication).
///
/// # Example
///
Expand Down Expand Up @@ -640,7 +640,7 @@ impl<Http: HttpClient> Client<Http> {

/// Get the API [Keys](Key) from Meilisearch with parameters.
///
/// See [`Client::create_key`], [`Client::get_key`], and the [meilisearch documentation](https://www.meilisearch.com/docs/reference/api/keys#get-all-keys).
/// See [`Client::create_key`], [`Client::get_key`], and the [meilisearch documentation](https://www.meilisearch.com/docs/reference/api/keys/list-api-keys#get-all-keys).
///
/// # Example
///
Expand Down Expand Up @@ -675,7 +675,7 @@ impl<Http: HttpClient> Client<Http> {

/// Get the API [Keys](Key) from Meilisearch.
///
/// See [`Client::create_key`], [`Client::get_key`], and the [meilisearch documentation](https://www.meilisearch.com/docs/reference/api/keys#get-all-keys).
/// See [`Client::create_key`], [`Client::get_key`], and the [meilisearch documentation](https://www.meilisearch.com/docs/reference/api/keys/list-api-keys#get-all-keys).
///
/// # Example
///
Expand Down Expand Up @@ -707,7 +707,7 @@ impl<Http: HttpClient> Client<Http> {

/// Get one API [Key] from Meilisearch.
///
/// See also [`Client::create_key`], [`Client::get_keys`], and the [meilisearch documentation](https://www.meilisearch.com/docs/reference/api/keys#get-one-key).
/// See also [`Client::create_key`], [`Client::get_keys`], and the [meilisearch documentation](https://www.meilisearch.com/docs/reference/api/keys/list-api-keys#get-one-key).
///
/// # Example
///
Expand Down Expand Up @@ -739,7 +739,7 @@ impl<Http: HttpClient> Client<Http> {

/// Delete an API [Key] from Meilisearch.
///
/// See also [`Client::create_key`], [`Client::update_key`], [`Client::get_key`], and the [meilisearch documentation](https://www.meilisearch.com/docs/reference/api/keys#delete-a-key).
/// See also [`Client::create_key`], [`Client::update_key`], [`Client::get_key`], and the [meilisearch documentation](https://www.meilisearch.com/docs/reference/api/keys/list-api-keys#delete-a-key).
///
/// # Example
///
Expand Down Expand Up @@ -774,7 +774,7 @@ impl<Http: HttpClient> Client<Http> {

/// Create an API [Key] in Meilisearch.
///
/// See also [`Client::update_key`], [`Client::delete_key`], [`Client::get_key`], and the [meilisearch documentation](https://www.meilisearch.com/docs/reference/api/keys#create-a-key).
/// See also [`Client::update_key`], [`Client::delete_key`], [`Client::get_key`], and the [meilisearch documentation](https://www.meilisearch.com/docs/reference/api/keys/list-api-keys#create-a-key).
///
/// # Example
///
Expand Down Expand Up @@ -811,7 +811,7 @@ impl<Http: HttpClient> Client<Http> {

/// Update an API [Key] in Meilisearch.
///
/// See also [`Client::create_key`], [`Client::delete_key`], [`Client::get_key`], and the [meilisearch documentation](https://www.meilisearch.com/docs/reference/api/keys#update-a-key).
/// See also [`Client::create_key`], [`Client::delete_key`], [`Client::get_key`], and the [meilisearch documentation](https://www.meilisearch.com/docs/reference/api/keys/list-api-keys#update-a-key).
///
/// # Example
///
Expand Down Expand Up @@ -1114,7 +1114,7 @@ impl<Http: HttpClient> Client<Http> {

/// List batches using the Batches API.
///
/// See: https://www.meilisearch.com/docs/reference/api/batches
/// See: https://www.meilisearch.com/docs/reference/api/async-task-management/list-batches
///
/// # Example
///
Expand Down
4 changes: 2 additions & 2 deletions src/documents.rs
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,7 @@ pub struct DocumentsQuery<'a, Http: HttpClient> {
/// Filters to apply.
///
/// Available since v1.2 of Meilisearch
/// Read the [dedicated guide](https://www.meilisearch.com/docs/learn/filtering_and_sorting) to learn the syntax.
/// Read the [dedicated guide](https://www.meilisearch.com/docs/learn/filtering_and_sorting/filter_search_results) to learn the syntax.
#[serde(skip_serializing_if = "Option::is_none")]
pub filter: Option<&'a str>,

Expand Down Expand Up @@ -391,7 +391,7 @@ pub struct DocumentDeletionQuery<'a, Http: HttpClient> {

/// Filters to apply.
///
/// Read the [dedicated guide](https://www.meilisearch.com/docs/learn/fine_tuning_results/filtering#filter-basics) to learn the syntax.
/// Read the [dedicated guide](https://www.meilisearch.com/docs/learn/filtering_and_sorting/filter_search_results#filter-basics) to learn the syntax.
pub filter: Option<&'a str>,
}

Expand Down
4 changes: 2 additions & 2 deletions src/dumps.rs
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
//! - During a dump import, all indexes contained in the indicated `.dump` file are imported along with their associated documents and [settings](crate::settings::Settings).
//! Any existing [index](crate::indexes::Index) with the same uid as an index in the dump file will be overwritten.
//!
//! - Dump imports are [performed at launch](https://www.meilisearch.com/docs/learn/configuration/instance_options#import-dump) using an option.
//! - Dump imports are [performed at launch](https://www.meilisearch.com/docs/learn/self_hosted/configure_meilisearch_at_launch#import-dump) using an option.
//!
//! # Example
//!
Expand Down Expand Up @@ -45,7 +45,7 @@ use crate::{client::Client, errors::Error, request::*, task_info::TaskInfo};
impl<Http: HttpClient> Client<Http> {
/// Triggers a dump creation process.
///
/// Once the process is complete, a dump is created in the [dumps directory](https://www.meilisearch.com/docs/learn/configuration/instance_options#dump-directory).
/// Once the process is complete, a dump is created in the [dumps directory](https://www.meilisearch.com/docs/learn/self_hosted/configure_meilisearch_at_launch#dump-directory).
/// If the dumps directory does not exist yet, it will be created.
///
/// # Example
Expand Down
4 changes: 2 additions & 2 deletions src/indexes.rs
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ use serde::{de::DeserializeOwned, Deserialize, Serialize};
use std::{collections::HashMap, fmt::Display, time::Duration};
use time::OffsetDateTime;

/// A Meilisearch [index](https://www.meilisearch.com/docs/learn/core_concepts/indexes).
/// A Meilisearch [index](https://www.meilisearch.com/docs/learn/getting_started/indexes).
///
/// # Example
///
Expand Down Expand Up @@ -1374,7 +1374,7 @@ impl<Http: HttpClient> Index<Http> {
.await
}

/// Get a [Task] from a specific [Index] to keep track of [asynchronous operations](https://www.meilisearch.com/docs/learn/advanced/asynchronous_operations).
/// Get a [Task] from a specific [Index] to keep track of [asynchronous operations](https://www.meilisearch.com/docs/learn/async/asynchronous_operations).
///
/// # Example
///
Expand Down
Loading
Loading