sdk cleanup (#1126)

Author: ahl

cli/Cargo.toml

@@ -38,7 +38,7 @@ log = { workspace = true }
 md5 = { workspace = true }
 oauth2 = { workspace = true }
 open = { workspace = true }
-oxide = { workspace = true, features = ["clap"] }
+oxide = { workspace = true, features = ["clap", "extras"] }
 oxnet = { workspace = true }
 predicates = { workspace = true }
 ratatui = { workspace = true }

sdk/Cargo.toml

@@ -10,9 +10,7 @@ readme = "README.md"
 [dependencies]
 base64 = { workspace = true }
 chrono = { workspace = true }
-clap = { workspace = true, optional = true }
 dirs = { workspace = true }
-flume = { workspace = true }
 futures = { workspace = true }
 progenitor-client = { workspace = true }
 rand = { workspace = true }
@@ -22,12 +20,18 @@ serde = { workspace = true }
 serde_json = { workspace = true }
 schemars = { workspace = true }
 thiserror =  { workspace = true }
-tokio = { workspace = true }
 toml = { workspace = true }
 toml_edit = { workspace = true }
 tracing = { workspace = true }
 uuid = { workspace = true }
 
+# Optional deps for the clap feature
+clap = { workspace = true, optional = true }
+
+# Optional deps for the extras feature
+flume = { workspace = true, optional = true }
+tokio = { workspace = true, optional = true }
+
 [dev-dependencies]
 tempfile = { workspace = true }
 test-common = { workspace = true }
@@ -36,4 +40,4 @@ tokio = { workspace = true }
 [features]
 default = []
 clap = ["dep:clap"]
-extras = []
+extras = ["dep:tokio", "dep:flume"]

sdk/src/auth.rs

@@ -14,6 +14,7 @@ use crate::{Client, OxideAuthError};
 use reqwest::ClientBuilder;
 use serde::Deserialize;
 
+/// Credentials for a particular profile.
 #[derive(Deserialize, Debug)]
 pub struct ProfileCredentials {
     pub token: String,
@@ -145,6 +146,7 @@ impl ClientConfig {
     }
 }
 
+// Structure of the credentials file.
 #[derive(Deserialize, Debug, Default)]
 #[serde(default)]
 pub struct CredentialsFile {

sdk/src/extras/disk.rs

@@ -4,6 +4,8 @@
 
 // Copyright 2025 Oxide Computer Company
 
+//! Types in service of the [ClientExtraDiskExt] trait.
+
 use super::ClientExtraDiskExt;
 use crate::Client;
 
@@ -13,6 +15,7 @@ impl ClientExtraDiskExt for Client {
     }
 }
 
+/// Builder for disk extra operations.
 pub mod builder {
     use crate::extras::disk::types::{DiskImportError, DiskImportHandle, DiskInfo, ImageInfo};
     use crate::types::{Name, NameOrId};
@@ -164,6 +167,7 @@ pub mod builder {
     }
 }
 
+/// Types for disk extra operations.
 pub mod types {
     use crate::types::{
         self, BlockSize, ByteCount, DiskCreate, DiskSource, DiskState, FinalizeDisk, ImageCreate,

sdk/src/extras/mod.rs

@@ -2,19 +2,24 @@
 // License, v. 2.0. If a copy of the MPL was not distributed with this
 // file, You can obtain one at https://mozilla.org/MPL/2.0/.
 
-// Copyright 2024 Oxide Computer Company
+// Copyright 2025 Oxide Computer Company
 
 //! The `extra` feature adds additional, non-generated, compound interfaces to
-//! the [`Client`](super::generated_sdk::Client). It is intended for methods
-//! that are functional rather than for those that offer enhanced output or a
-//! simplified interface. (This is why the the CLI uses a disk import interface
-//! from here, but has a number of custom network subcommands that pretty-print
-//! or provide a simpler user interface for common use cases.)
+//! the [`Client`](crate::Client).
+//!
+//! It is intended for methods that are functional rather than for those that
+//! offer enhanced output or a simplified interface.
 //!
 //! These interfaces operate very similarly to the generated interfaces.
 
+// Note: This is why the the CLI uses a disk import interface from here, but
+// has a number of custom network subcommands that pretty-print or provide a
+// simpler user interface for common use cases.
+
 pub mod disk;
 
+/// Higher level operations beyond the generated operations from
+/// [`ClientDisksExt`](crate::ClientDisksExt)
 pub trait ClientExtraDiskExt {
     /// A convenience wrapper around the SDK to simplify disk creation.
     /// Create a disk, optionally with a snapshot and image. The standard

sdk/src/lib.rs

@@ -20,6 +20,7 @@ use tracing::{Level, Span};
 mod auth;
 #[cfg(feature = "clap")]
 mod clap_feature;
+#[cfg(feature = "extras")]
 pub mod extras;
 mod generated_sdk;