docs: partial lintfix

input-output-hk · Nov 7, 2024 · eee866e · eee866e
1 parent 1c8613e
commit eee866e
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/catalyst-gateway/bin/src/service/api/legacy/v0/proposals_post.rs b/catalyst-gateway/bin/src/service/api/legacy/v0/proposals_post.rs
@@ -24,10 +24,13 @@ pub(crate) async fn endpoint(_message: Vec<dto::VotingHistoryItem>) -> AllRespon
 pub(crate) mod dto {
     use poem_openapi::Object;
 
+    /// An option item to specify proposal to query.
     #[allow(clippy::missing_docs_in_private_items)]
     #[derive(Object, Default)]
     pub(crate) struct VotingHistoryItem {
+        #[oai(validator(max_length = 256, min_length = 0, pattern = "[A-Za-z0-9_-]"))]
         vote_plan_id: String,
+        #[oai(validator(minimum(value = "0"), maximum(value = "4294967295")))]
         indexes: u32,
     }
 }
diff --git a/catalyst-gateway/bin/src/service/common/objects/legacy/fund.rs b/catalyst-gateway/bin/src/service/common/objects/legacy/fund.rs
@@ -2,8 +2,10 @@
 
 use poem_openapi::Object;
 
+/// The fund object.
 #[allow(clippy::missing_docs_in_private_items)]
 #[derive(Object, Default)]
 pub(crate) struct Fund {
+    #[oai(validator(max_length = 256, min_length = 0, pattern = "[A-Za-z0-9_-]"))]
     id: String,
 }