global: snapshot

crates/brk_server/src/params/addr_param.rs

@@ -3,6 +3,7 @@ use serde::Deserialize;
 
 use brk_types::Addr;
 
+/// Bitcoin address path parameter
 #[derive(Deserialize, JsonSchema)]
 pub struct AddrParam {
     #[serde(rename = "address")]

crates/brk_server/src/params/block_count_param.rs

@@ -1,6 +1,7 @@
 use schemars::JsonSchema;
 use serde::Deserialize;
 
+/// Block count path parameter
 #[derive(Deserialize, JsonSchema)]
 pub struct BlockCountParam {
     /// Number of recent blocks to include

crates/brk_server/src/params/blockhash_param.rs

@@ -3,6 +3,7 @@ use serde::Deserialize;
 
 use brk_types::BlockHash;
 
+/// Block hash path parameter
 #[derive(Deserialize, JsonSchema)]
 pub struct BlockHashParam {
     pub hash: BlockHash,

crates/brk_server/src/params/blockhash_start_index.rs

@@ -3,6 +3,7 @@ use serde::Deserialize;
 
 use brk_types::{BlockHash, TxIndex};
 
+/// Block hash + starting transaction index path parameters
 #[derive(Deserialize, JsonSchema)]
 pub struct BlockHashStartIndex {
     /// Bitcoin block hash

crates/brk_server/src/params/blockhash_tx_index.rs

@@ -3,6 +3,7 @@ use serde::Deserialize;
 
 use brk_types::{BlockHash, TxIndex};
 
+/// Block hash + transaction index path parameters
 #[derive(Deserialize, JsonSchema)]
 pub struct BlockHashTxIndex {
     /// Bitcoin block hash

crates/brk_server/src/params/height_param.rs

@@ -3,6 +3,7 @@ use serde::Deserialize;
 
 use brk_types::Height;
 
+/// Block height path parameter
 #[derive(Deserialize, JsonSchema)]
 pub struct HeightParam {
     pub height: Height,

crates/brk_server/src/params/pool_slug_param.rs

@@ -3,11 +3,13 @@ use serde::Deserialize;
 
 use brk_types::{Height, PoolSlug};
 
+/// Mining pool slug path parameter
 #[derive(Deserialize, JsonSchema)]
 pub struct PoolSlugParam {
     pub slug: PoolSlug,
 }
 
+/// Mining pool slug + block height path parameters
 #[derive(Deserialize, JsonSchema)]
 pub struct PoolSlugAndHeightParam {
     pub slug: PoolSlug,

crates/brk_server/src/params/time_period_param.rs

@@ -3,6 +3,7 @@ use serde::Deserialize;
 
 use brk_types::TimePeriod;
 
+/// Time period path parameter (24h, 3d, 1w, 1m, 3m, 6m, 1y, 2y, 3y)
 #[derive(Deserialize, JsonSchema)]
 pub struct TimePeriodParam {
     #[schemars(example = &"24h")]

crates/brk_server/src/params/timestamp_param.rs

@@ -3,11 +3,13 @@ use serde::Deserialize;
 
 use brk_types::Timestamp;
 
+/// UNIX timestamp path parameter
 #[derive(Deserialize, JsonSchema)]
 pub struct TimestampParam {
     pub timestamp: Timestamp,
 }
 
+/// Optional UNIX timestamp query parameter
 #[derive(Deserialize, JsonSchema)]
 pub struct OptionalTimestampParam {
     pub timestamp: Option<Timestamp>,

crates/brk_server/src/params/txid_param.rs

@@ -3,6 +3,7 @@ use serde::Deserialize;
 
 use brk_types::Txid;
 
+/// Transaction ID path parameter
 #[derive(Deserialize, JsonSchema)]
 pub struct TxidParam {
     pub txid: Txid,