Merge #58

58: Changes about the MeiliSearch's next release (v0.16.0) r=curquiza a=curquiza

Related to this issue: meilisearch/integration-guides#52

- [x] Update README
- [x] Remove `set_health` method and rename method `get_health` into `health` #59 

This PR:
- gathers the changes related to the next release of MeiliSearch (v0.16.0) so that this package is ready when the official release is out.
- should pass the tests against the [latest prerelease of MeiliSearch](https://github.com/meilisearch/MeiliSearch/releases). This should be tested locally.
- might eventually fail until the MeiliSearch v0.16.0 is out.

⚠️ This PR should NOT be merged until the MeiliSearch's next release (v0.16.0) is out.

Co-authored-by: Clementine Urquizar <[email protected]>
Co-authored-by: Clémentine Urquizar <[email protected]>

Author: bors[bot]

.code-samples.meilisearch.yaml

@@ -193,10 +193,8 @@ get_index_stats_1: |-
 get_indexes_stats_1: |-
   let stats: ClientStats = client.get_stats().await.unwrap();
 get_health_1: |-
-  // get_health() return an Err() if the server is not healthy, so this example would panic due to the unwrap
-  client.get_health().await.unwrap();
-update_health_1: |-
-  client.set_health(false).await.unwrap();
+  // health() return an Err() if the server is not healthy, so this example would panic due to the unwrap
+  client.health().await.unwrap();
 get_version_1: |-
   let version: Version = client.get_version().await.unwrap();
 distinct_attribute_guide_1: |-

README.md

@@ -139,7 +139,7 @@ WARNING: `meilisearch-sdk` will panic if no Window is available (ex: Web extensi
 
 ## 🤖 Compatibility with MeiliSearch
 
-This package only guarantees the compatibility with the [version v0.15.0 of MeiliSearch](https://github.com/meilisearch/MeiliSearch/releases/tag/v0.15.0).
+This package only guarantees the compatibility with the [version v0.16.0 of MeiliSearch](https://github.com/meilisearch/MeiliSearch/releases/tag/v0.16.0).
 
 ## ⚙️ Development Workflow and Contributing
 

README.tpl

@@ -47,7 +47,7 @@ See our [Documentation](https://docs.meilisearch.com/guides/introduction/quick_s
 
 ## 🤖 Compatibility with MeiliSearch
 
-This package only guarantees the compatibility with the [version v0.15.0 of MeiliSearch](https://github.com/meilisearch/MeiliSearch/releases/tag/v0.15.0).
+This package only guarantees the compatibility with the [version v0.16.0 of MeiliSearch](https://github.com/meilisearch/MeiliSearch/releases/tag/v0.16.0).
 
 ## ⚙️ Development Workflow and Contributing
 

src/client.rs

@@ -1,6 +1,6 @@
 use crate::{errors::*, indexes::*, request::*};
 use serde_json::{json, Value};
-use serde::{Serialize, Deserialize};
+use serde::{Deserialize};
 use std::collections::HashMap;
 
 /// The top-level struct of the SDK, representing a client containing [indexes](../indexes/struct.Index.html).
@@ -186,7 +186,7 @@ impl<'a> Client<'a> {
     /// # async fn main() {
     /// let client = Client::new("http://localhost:7700", "masterKey");
     ///
-    /// match client.get_health().await {
+    /// match client.health().await {
     ///     Ok(()) => println!("server is operational"),
     ///     Err(Error::MeiliSearchError { error_code: ErrorCode::Maintenance, .. }) => {
     ///         eprintln!("server is in maintenance")
@@ -195,7 +195,7 @@ impl<'a> Client<'a> {
     /// }
     /// # }
     /// ```
-    pub async fn get_health(&self) -> Result<(), Error> {
+    pub async fn health(&self) -> Result<(), Error> {
         let r = request::<(), ()>(
             &format!("{}/health", self.host),
             self.apikey,
@@ -211,42 +211,6 @@ impl<'a> Client<'a> {
         }
     }
 
-    /// Update health of MeiliSearch server.
-    ///
-    /// # Example
-    ///
-    /// ```
-    /// # use meilisearch_sdk::{client::*, indexes::*};
-    /// #
-    /// # #[tokio::main]
-    /// # async fn main() {
-    /// let client = Client::new("http://localhost:7700", "masterKey");
-    ///
-    /// client.set_health(false).await.unwrap();
-    /// # client.set_health(true).await.unwrap();
-    /// # }
-    /// ```
-    pub async fn set_health(&self, health: bool) -> Result<(), Error> {
-        #[derive(Debug, Serialize)]
-        struct HealthBody {
-            health: bool
-        }
-
-        let r = request::<HealthBody, ()>(
-            &format!("{}/health", self.host),
-            self.apikey,
-            Method::Put(HealthBody { health }),
-            204,
-        )
-        .await;
-        match r {
-            // This shouldn't be an error; The status code is 200, but the request
-            // function only supports one successful error code for some reason
-            Err(Error::Empty) => Ok(()),
-            e => e,
-        }
-    }
-
     /// Get version of the MeiliSearch server.
     ///
     /// # Example

src/errors.rs

@@ -21,7 +21,7 @@ pub enum Error {
     /// The MeiliSearch server returned invalid JSON for a request.
     ParseError(serde_json::Error),
     /// An erroring status code, but no body
-    // This is a hack to make Client::get_health work, since the request module
+    // This is a hack to make Client::health work, since the request module
     // treats anything other than the expected status as an error.  Since 204 is
     // specified, a successful status of 200 is treated as an error with an
     // empty body.
@@ -97,8 +97,7 @@ pub enum ErrorCode {
     InternalError,
     /// The provided token is invalid.
     InvalidToken,
-    /// The MeiliSearch instance is under maintenance. You can set the maintenance
-    /// state by using the `set_healthy` method of a Client.
+    /// The MeiliSearch instance is under maintenance.
     Maintenance,
     /// The requested resources are protected with an API key, which was not
     /// provided in the request header.