documentation for SpenderResponse + examples

Author: simzzz

primitives/Cargo.toml

@@ -48,6 +48,9 @@ required-features = ["test-util"]
 [[example]]
 name = "modify_campaign"
 
+[[example]]
+name = "spender_response"
+
 [dependencies]
 # (De)Serialization
 serde = { version = "1.0", features = ["derive"] }

primitives/examples/spender_response.rs

@@ -0,0 +1,12 @@
+use primitives::{sentry::SpenderResponse};
+use serde_json::{from_value, json};
+
+fn main() {
+    let json = json!({
+        "spender": {
+            "totalDeposited": "10000000000",
+            "totalSpent": "100000000",
+        },
+    });
+    assert!(from_value::<SpenderResponse>(json).is_ok());
+}

primitives/src/sentry.rs

@@ -598,6 +598,13 @@ pub struct SuccessResponse {
     pub success: bool,
 }
 
+/// Spender limits for a spender on a channel.
+///
+/// # Examples
+///
+/// ```
+#[doc = include_str!("../examples/spender_response.rs")]
+/// ```
 #[derive(Serialize, Deserialize, Debug)]
 #[serde(rename_all = "camelCase")]
 pub struct SpenderResponse {

sentry/src/routes.rs

@@ -70,10 +70,19 @@
 //! ```
 //!
 //! #### GET `/v5/channel/:id/spender/:addr` (auth required)
+//! 
+//! Gets the spender limits for a spender on a channel. It does so by fetching the
+//! latest Spendable entry from the database (or creating one if it doesn't exist yet) from which
+//! the total deposited amount is retrieved, and the latest NewState from which the total spent
+//! amount is retrieved.
 //!
 //! The route is handled by [`channel::get_spender_limits()`].
 //!
-//! Response: [`SpenderResponse`](primitives::sentry::SpenderResponse)
+//! Response:
+//!
+//! ```
+#![doc = include_str!("../../primitives/examples/spender_response.rs")]
+//! ```
 //!
 //! #### POST `/v5/channel/:id/spender/:addr` (auth required)
 //!