a few more tidy-ups

Author: analogrelay

sdk/cosmosdb/azure_data_cosmos/Cargo.toml

@@ -9,8 +9,8 @@ license.workspace = true
 repository.workspace = true
 rust-version.workspace = true
 homepage = "https://github.com/azure/azure-sdk-for-rust"
-documentation = "https://docs.rs/azure_identity"
-keywords = ["sdk", "azure", "rest", "iot", "cloud"]
+documentation = "https://docs.rs/azure_data_cosmos"
+keywords = ["sdk", "azure", "rest", "cloud", "cosmosdb", "database"]
 categories = ["api-bindings"]
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

sdk/cosmosdb/azure_data_cosmos/examples/cosmosdb_connect.rs

@@ -1,5 +1,3 @@
-// REVIEW: Don't merge this file. It's just for adhoc testing purposes.
-
 use azure_data_cosmos::{CosmosClient, CosmosClientMethods, DatabaseClientMethods};
 use clap::Parser;
 

sdk/cosmosdb/azure_data_cosmos/src/clients/cosmos_client.rs

@@ -17,12 +17,17 @@ pub struct CosmosClient {
     options: CosmosClientOptions,
 }
 
+/// Defines the methods provided by a [`CosmosClient`]
+///
+/// This trait is intended to allow you to mock out the `CosmosClient` when testing your application.
+/// Rather than depending on `CosmosClient`, you can depend on a generic parameter constrained by this trait, or an `impl CosmosClientMethods` type.
 pub trait CosmosClientMethods {
+    /// Gets a [`DatabaseClient`] that can be used to access the database with the specified ID.
     fn database(&self, name: impl Into<String>) -> DatabaseClient;
 }
 
 impl CosmosClient {
-    /// Creates a new CosmosClient from the specified [TokenCredential] and [CosmosClientOptions].
+    /// Creates a new CosmosClient, using Entra ID authentication.
     pub fn new(
         endpoint: impl AsRef<str>,
         credential: Arc<dyn TokenCredential>,
@@ -39,6 +44,7 @@ impl CosmosClient {
         })
     }
 
+    /// Creates a new CosmosClient, using shared key authentication.
     #[cfg(feature = "key-auth")]
     pub fn with_shared_key(
         endpoint: impl AsRef<str>,
@@ -56,12 +62,14 @@ impl CosmosClient {
         })
     }
 
+    /// Gets the endpoint of the database account this client is connected to.
     pub fn endpoint(&self) -> &Url {
         &self.endpoint
     }
 }
 
 impl CosmosClientMethods for CosmosClient {
+    /// Gets a [`DatabaseClient`] that can be used to access the database with the specified ID.
     fn database(&self, id: impl Into<String>) -> DatabaseClient {
         DatabaseClient::new(self.clone(), id.into())
     }

sdk/cosmosdb/azure_data_cosmos/src/clients/database_client.rs

@@ -5,12 +5,10 @@ use azure_core::{Context, Request};
 use url::Url;
 
 pub trait DatabaseClientMethods {
-    fn read(
+    async fn read(
         &self,
         options: Option<ReadDatabaseOptions>,
-    ) -> impl std::future::Future<
-        Output = azure_core::Result<azure_core::Response<DatabaseProperties>>,
-    > + Send;
+    ) -> azure_core::Result<azure_core::Response<DatabaseProperties>>;
 }
 
 pub struct DatabaseClient {

sdk/cosmosdb/azure_data_cosmos/src/clients/mod.rs

@@ -1,5 +1,5 @@
-mod database_client;
 mod cosmos_client;
+mod database_client;
 
-pub use database_client::{DatabaseClient, DatabaseClientMethods};
 pub use cosmos_client::{CosmosClient, CosmosClientMethods};
+pub use database_client::{DatabaseClient, DatabaseClientMethods};

sdk/cosmosdb/azure_data_cosmos/src/options/mod.rs

@@ -2,7 +2,7 @@ use azure_core::ClientOptions;
 
 #[derive(Clone, Debug, Default)]
 pub struct CosmosClientOptions {
-    pub(crate) client_options: ClientOptions
+    pub(crate) client_options: ClientOptions,
 }
 
 impl CosmosClientOptions {
@@ -12,19 +12,12 @@ impl CosmosClientOptions {
 }
 
 #[derive(Clone, Debug, Default)]
-pub struct ReadDatabaseOptions {
-    pub(crate) if_match: Option<azure_core::Etag>,
-    pub(crate) if_none_match: Option<azure_core::Etag>,
-}
+pub struct ReadDatabaseOptions {}
 
-impl ReadDatabaseOptions {
-    pub fn builder() -> builders::ReadDatabaseOptionsBuilder {
-        builders::ReadDatabaseOptionsBuilder::default()
-    }
-}
+impl ReadDatabaseOptions {}
 
 pub mod builders {
-    use crate::{ReadDatabaseOptions, CosmosClientOptions};
+    use crate::{CosmosClientOptions, ReadDatabaseOptions};
 
     #[derive(Default)]
     pub struct CosmosClientOptionsBuilder(CosmosClientOptions);
@@ -42,15 +35,5 @@ pub mod builders {
         pub fn build(&self) -> ReadDatabaseOptions {
             self.0.clone()
         }
-
-        pub fn if_match(&mut self, if_match: azure_core::Etag) -> &mut Self {
-            self.0.if_match = Some(if_match);
-            self
-        }
-
-        pub fn if_none_match(&mut self, if_none_match: azure_core::Etag) -> &mut Self {
-            self.0.if_none_match = Some(if_none_match);
-            self
-        }
     }
 }