added documentation for GET /cfg

Author: simzzz

primitives/Cargo.toml

@@ -72,6 +72,9 @@ name = "validator_messages_list_query"
 [[example]]
 name = "validator_messages_list_response"
 
+[[example]]
+name = "get_cfg_response"
+
 [dependencies]
 # (De)Serialization
 serde = { version = "1.0", features = ["derive"] }

primitives/examples/get_cfg_response.rs

@@ -0,0 +1,66 @@
+use primitives::Config;
+use serde_json::{from_value, json};
+
+fn main() {
+    let json = json!({
+        "max_channels":512,
+        "channels_find_limit":200,
+        "campaigns_find_limit":200,
+        "spendable_find_limit":200,
+        "wait_time":{"secs":0,"nanos":500000000},
+        "msgs_find_limit":10,
+        "analytics_find_limit":5000,
+        "analytics_maxtime":{"secs":20,"nanos":0},
+        "heartbeat_time":{"secs":30,"nanos":0},
+        "health_threshold_promilles":950,
+        "health_unsignable_promilles":750,
+        "propagation_timeout":{"secs":2,"nanos":0},
+        "fetch_timeout":{"secs":5,"nanos":0},
+        "all_campaigns_timeout":{"secs":5,"nanos":0},
+        "channel_tick_timeout":{"secs":8,"nanos":0},
+        "ip_rate_limit":{"type":"ip","timeframe":1200000},
+        "creators_whitelist":[],
+        "validators_whitelist":[],
+        "admins":["0x80690751969B234697e9059e04ed72195c3507fa"],
+        "chain":{
+            "Ganache #1337": {
+                "chain_id":1337,
+                "rpc":"http://localhost:1337/",
+                "outpace":"0xAbc27d46a458E2e49DaBfEf45ca74dEDBAc3DD06",
+                "token":{
+                    "Mocked TOKEN 1337":{
+                        "min_campaign_budget":"1000000000000000000",
+                        "min_validator_fee":"1000000000000",
+                        "precision":18,
+                        "address":"0x2BCaf6968aEC8A3b5126FBfAb5Fd419da6E8AD8E"
+                    }
+                }
+            },
+            "Ganache #1":{
+                "chain_id":1,
+                "rpc":"http://localhost:8545/",
+                "outpace":"0x26CBc2eAAe377f6Ac4b73a982CD1125eF4CEC96f",
+                "token":{
+                    "Mocked TOKEN 1":{
+                        "min_campaign_budget":"1000000000000000000",
+                        "min_validator_fee":"1000000000000",
+                        "precision":18,
+                        "address":"0x12a28f2bfBFfDf5842657235cC058242f40fDEa6"
+                    }
+                }
+            }
+        },
+        "platform":{
+            "url":"https://platform.adex.network/",
+            "keep_alive_interval":{"secs":1200,"nanos":0}
+        },
+        "limits":{
+            "units_for_slot":{
+                "max_campaigns_earning_from":25,
+                "global_min_impression_price":"1000000"
+            }
+        }
+    });
+    let val = from_value::<Config>(json).expect("should convert");
+    // assert!(from_value::<Config>(json).is_ok());
+}

primitives/src/config.rs

@@ -47,6 +47,10 @@ impl Default for Environment {
     }
 }
 
+/// Examples:
+/// ```
+#[doc = include_str!("../../primitives/examples/get_cfg_response.rs")]
+/// ```
 #[derive(Serialize, Deserialize, Debug, Clone)]
 pub struct Config {
     /// The maximum number of [`Channel`](crate::Channel)s that the worker

sentry/src/routes.rs

@@ -466,6 +466,22 @@
 //!
 //! See [GET `/v5/analytics`](#get-v5analytics)
 //!
+//! #### GET `/cfg`
+//!
+//! Gets the config that the validator is running on.
+//!
+//! The route is handled by [`sentry::routes::cfg::get_config()`]
+//!
+//! Response: [`Config`](primitives::Config)
+//!
+//! ##### Examples
+//!
+//! Response:
+//!
+//! ```
+#![doc = include_str!("../../primitives/examples/get_cfg_response.rs")]
+//! ```
+//!
 //! [`Adapter`]: adapter::Adapter
 //! [`Address`]: primitives::Address
 //! [`AllowedKey`]: primitives::analytics::query::AllowedKey

sentry/src/routes/cfg.rs

@@ -9,7 +9,9 @@ use primitives::Config;
 
 use crate::Application;
 
-/// `GET /cfg` request
+/// GET `/cfg` request
+///
+/// Response: [`Config`]
 pub async fn config<C: Locked + 'static>(
     Extension(app): Extension<Arc<Application<C>>>,
 ) -> Json<Config> {