Documentation + examples for channel get all spenders route

Author: simzzz

primitives/Cargo.toml

@@ -23,6 +23,9 @@ test-util = []
 [[example]]
 name = "accounting_response"
 
+[[example]]
+name = "all_spenders_response"
+
 [[example]]
 name = "analytics_query"
 

primitives/examples/all_spenders_response.rs

@@ -0,0 +1,24 @@
+use primitives::sentry::AllSpendersResponse;
+use serde_json::{from_value, json};
+
+fn main() {
+    let json = json!({
+        "spenders": {
+            "0x0000000000000000000000000000000000000000": {
+                "totalDeposited": "10000000000",
+                "totalSpent": "100000000",
+            },
+            "0x1111111111111111111111111111111111111111": {
+                "totalDeposited": "90000000000",
+                "totalSpent": "20000000000",
+            },
+            "0x2222222222222222222222222222222222222222": {
+                "totalDeposited": "1000000000",
+                "totalSpent": "1000000000",
+            },
+        },
+        "totalPages": 1,
+        "page": 0
+    });
+    assert!(from_value::<AllSpendersResponse>(json).is_ok());
+}

primitives/src/sentry.rs

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

sentry/src/routes.rs

@@ -71,7 +71,7 @@
 //!
 //! #### GET `/v5/channel/:id/spender/:addr` (auth required)
 //!
-//! Gets the spender limits for a spender on a channel. It does so by fetching the
+//! 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.
@@ -96,9 +96,15 @@
 //!
 //! #### GET `/v5/channel/:id/spender/all` (auth required)
 //!
+//! This routes gets total_deposited and total_spent for every spender on a [`Channel`]
+//!
 //! The route is handled by [`channel::get_all_spender_limits()`].
 //!
-//! Response: [`AllSpendersResponse`](primitives::sentry::AllSpendersResponse)
+//! Response:
+//!
+//! ```
+#![doc = include_str!("../../primitives/examples/all_spenders_response.rs")]
+//! ```
 //!
 //! #### GET `/v5/channel/:id/validator-messages`
 //!