add docs

input-output-hk · Sep 19, 2023 · 3ffb57a · 3ffb57a
1 parent 2628a13
commit 3ffb57a
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/src/cat-data-service/src/service/api/health/mod.rs b/src/cat-data-service/src/service/api/health/mod.rs
@@ -1,3 +1,6 @@
+//! Health endpoints, which return the status of the service.
+//! Mostly used by Grafana.
+//! 
 use crate::service::common::tags::ApiTags;
 use poem_openapi::OpenApi;
 

diff --git a/src/cat-data-service/src/service/api/registration/mod.rs b/src/cat-data-service/src/service/api/registration/mod.rs
@@ -1,3 +1,5 @@
+//! Registration endpoints, which return relevant voter's registration information.
+//! 
 use crate::service::common::objects::{
     event_id::EventId, voter_registration::VoterRegistration, voting_public_key::VotingPublicKey,
 };