[sdk-rs] Improve Docs (#7)

patrick-ogrady · web-flow · commit 8a36f0e26b23 · 2025-06-14T22:34:50.000-07:00
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -6,7 +6,7 @@ members = [
 resolver = "2"
 
 [workspace.dependencies]
-exoware-sdk-rs = { version = "0.0.1", path = "sdk-rs" }
+exoware-sdk-rs = { version = "0.0.2", path = "sdk-rs" }
 tokio = "1.43.0"
 clap = "4.5.18"
 tracing = "0.1.41"
@@ -54,4 +54,4 @@ debug = true
 [profile.test]
 # Although overflow checks are enabled by default in "test", we explicitly
 # enable them here for clarity.
-overflow-checks = true
+overflow-checks = true
diff --git a/examples/sandbox/package-lock.json b/examples/sandbox/package-lock.json
diff --git a/examples/sandbox/package.json b/examples/sandbox/package.json
@@ -1,7 +1,7 @@
 {
   "name": "exoware-sandbox",
   "private": true,
-  "version": "0.0.0",
+  "version": "0.0.2",
   "type": "module",
   "scripts": {
     "postinstall": "npm --prefix ../../sdk-ts install && npm --prefix ../../sdk-ts run build",
diff --git a/interface.yaml b/interface.yaml
@@ -2,7 +2,7 @@ openapi: 3.0.0
 info:
   title: Exoware API
   description: The canonical interface for all Exoware Components.
-  version: 0.0.1
+  version: 0.0.2
   contact:
     name: Commonware, Inc.
     email: support@commonware.xyz
@@ -220,4 +220,4 @@ paths:
         '401':
           description: Unauthorized
         '500':
-          description: Internal Server Error
+          description: Internal Server Error
diff --git a/sdk-rs/Cargo.toml b/sdk-rs/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "exoware-sdk-rs"
-version = "0.0.1"
+version = "0.0.2"
 edition = "2021"
 publish = true
 license = "MIT OR Apache-2.0"
@@ -20,4 +20,4 @@ serde_json = { workspace = true }
 thiserror = { workspace = true }
 tokio = { workspace = true, features = ["full"] }
 tokio-tungstenite = { workspace = true, features = ["native-tls"] }
-url = { workspace = true }
+url = { workspace = true }
diff --git a/sdk-rs/src/error.rs b/sdk-rs/src/error.rs
@@ -2,7 +2,7 @@ use reqwest::StatusCode;
 use thiserror::Error;
 use tokio_tungstenite::tungstenite;
 
-/// The error type for the SDK.
+/// Errors that can occur when interacting with the Exoware API.
 #[derive(Error, Debug)]
 pub enum Error {
     /// An error from the underlying `reqwest` HTTP client.
diff --git a/sdk-rs/src/lib.rs b/sdk-rs/src/lib.rs
@@ -1,6 +1,7 @@
 //! Rust SDK for the Exoware API.
 
-pub mod error;
+mod error;
+pub use error::Error;
 pub mod store;
 pub mod stream;
 
diff --git a/sdk-rs/src/store.rs b/sdk-rs/src/store.rs
@@ -1,3 +1,5 @@
+//! Persist and retrieve artifacts.
+
 use crate::{error::Error, Client as SdkClient};
 use base64::{engine::general_purpose, Engine as _};
 use reqwest::header::{HeaderValue, AUTHORIZATION};
diff --git a/sdk-rs/src/stream.rs b/sdk-rs/src/stream.rs
@@ -1,3 +1,5 @@
+//! Broadcast realtime data.
+
 use crate::{error::Error, Client as SdkClient};
 use futures_util::{
     stream::{SplitSink, SplitStream},
diff --git a/sdk-ts/package-lock.json b/sdk-ts/package-lock.json
diff --git a/sdk-ts/package.json b/sdk-ts/package.json
@@ -1,6 +1,6 @@
 {
     "name": "exoware-sdk-ts",
-    "version": "0.0.1",
+    "version": "0.0.2",
     "description": "TypeScript SDK for the Exoware API.",
     "license": "(MIT OR Apache-2.0)",
     "homepage": "https://exoware.xyz",
diff --git a/simulator/Cargo.toml b/simulator/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "exoware-simulator"
-version = "0.0.1"
+version = "0.0.2"
 edition = "2021"
 publish = true
 license = "MIT OR Apache-2.0"
@@ -34,4 +34,4 @@ url = { workspace = true }
 
 [[bin]]
 name = "simulator"
-path = "src/main.rs"
+path = "src/main.rs"
diff --git a/simulator/tests/e2e.rs b/simulator/tests/e2e.rs
@@ -1,4 +1,4 @@
-use exoware_sdk_rs::{error::Error, Client};
+use exoware_sdk_rs::{Client, Error};
 use exoware_simulator::testing::with_server;
 use futures_util::StreamExt;
 use std::time::Duration;

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "exoware-sandbox",`
`3`	`3`	`"private": true,`
`4`		`- "version": "0.0.0",`
	`4`	`+ "version": "0.0.2",`
`5`	`5`	`"type": "module",`
`6`	`6`	`"scripts": {`
`7`	`7`	`"postinstall": "npm --prefix ../../sdk-ts install && npm --prefix ../../sdk-ts run build",`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+//! Persist and retrieve artifacts.`
	`2`	`+`
`1`	`3`	`use crate::{error::Error, Client as SdkClient};`
`2`	`4`	`use base64::{engine::general_purpose, Engine as _};`
`3`	`5`	`use reqwest::header::{HeaderValue, AUTHORIZATION};`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+//! Broadcast realtime data.`
	`2`	`+`
`1`	`3`	`use crate::{error::Error, Client as SdkClient};`
`2`	`4`	`use futures_util::{`
`3`	`5`	`stream::{SplitSink, SplitStream},`