chore: add docs

1 files changed, 7 insertions, 0 deletions

diff --git a/src/repository/routes.rs b/src/repository/routes.rs
index 634d210..0683b47 100644
--- a/src/repository/routes.rs
+++ b/src/repository/routes.rs
@@ -5,9 +5,12 @@ use actix_web::{web, HttpResponse, Responder};
 use slog::info;
 use uuid::Uuid;
 
+/// Endpoint used for retrieve all repositories
 async fn index(state: web::Data<AppState>) -> impl Responder {
     let result = Repository::find_all(state.pool.clone()).await;
     info!(state.log, "GET /repo/");
+
+    // If raises an `Err`, returns an error in JSON format
     match result {
         Ok(repos) => HttpResponse::Ok().json(repos),
         _ => HttpResponse::BadRequest().json(AppErrorResponse {
@@ -17,12 +20,16 @@ async fn index(state: web::Data<AppState>) -> impl Responder {
     }
 }
 
+/// Endpoint used for retrieve a repository that matches with an `id`.
+/// It is a String, casted in an Uuid format.
 async fn get_repo(
     state: web::Data<AppState>,
     id: web::Path<(Uuid,)>,
 ) -> impl Responder {
     let result = Repository::find(state.pool.clone(), &id.0).await;
     info!(state.log, "GET /repo/{}/", id.0);
+
+    // `map_err` is also used when repo is not found
     result
         .map(|repo| HttpResponse::Ok().json(repo))
         .map_err(|e| e)