doc(aggregator-client): add missing doc

Author: Alenar

internal/mithril-aggregator-client/src/client.rs

@@ -14,6 +14,7 @@ use crate::query::{AggregatorQuery, QueryContext, QueryMethod};
 
 const API_VERSION_MISMATCH_WARNING_MESSAGE: &str = "OpenAPI version may be incompatible, please update Mithril client library to the latest version.";
 
+/// A client to send HTTP requests to a Mithril Aggregator
 pub struct AggregatorClient {
     pub(super) aggregator_endpoint: Url,
     pub(super) api_version_provider: APIVersionProvider,
@@ -30,6 +31,7 @@ impl AggregatorClient {
         AggregatorClientBuilder::new(aggregator_url)
     }
 
+    /// Send the given query to the Mithril Aggregator
     pub async fn send<Q: AggregatorQuery>(&self, query: Q) -> AggregatorClientResult<Q::Response> {
         // Todo: error handling ? Reuse the version in `warn_if_api_version_mismatch` ?
         let current_api_version = self.api_version_provider.compute_current_version().unwrap();

internal/mithril-aggregator-client/src/lib.rs

@@ -16,4 +16,5 @@ pub use error::AggregatorClientError;
 pub(crate) const JSON_CONTENT_TYPE: reqwest::header::HeaderValue =
     reqwest::header::HeaderValue::from_static("application/json");
 
+/// Aggregator-client result type
 pub type AggregatorClientResult<T> = Result<T, error::AggregatorClientError>;

internal/mithril-aggregator-client/src/query/certificate/get_certificate_details.rs

@@ -8,12 +8,14 @@ use crate::AggregatorClientResult;
 use crate::error::AggregatorClientError;
 use crate::query::{AggregatorQuery, QueryContext, QueryMethod};
 
+/// Get the details of a certificate
 pub struct CertificateDetailsQuery {
     hash: String,
 }
 
 impl CertificateDetailsQuery {
-    pub fn new(hash: String) -> Self {
+    /// Instantiate a query to get a certificate by hash
+    pub fn by_hash(hash: String) -> Self {
         Self { hash }
     }
 }

internal/mithril-aggregator-client/src/query/mod.rs

@@ -1,3 +1,8 @@
+//! Provides queries to retrieve or send data to a Mithril aggregator
+//!
+//! Available queries
+//! - Certificate: Get by hash
+//!
 mod api;
 mod certificate;