From 96be29a818e15619ef3011c00c4f4f2b5dab9f36 Mon Sep 17 00:00:00 2001 From: kdeng00 Date: Fri, 22 Aug 2025 15:22:51 -0400 Subject: [PATCH] tsk-170: Some documentation --- src/callers/song.rs | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/callers/song.rs b/src/callers/song.rs index 793752e..00cb740 100644 --- a/src/callers/song.rs +++ b/src/callers/song.rs @@ -117,9 +117,11 @@ pub mod request { pub mod response { use serde::{Deserialize, Serialize}; + /// Song queue response #[derive(Default, Deserialize, Serialize, utoipa::ToSchema)] pub struct Response { pub message: String, + /// Id of the queued song pub data: Vec, } @@ -867,6 +869,7 @@ mod song_queue { } } +/// Module for song related endpoints pub mod endpoint { use axum::{Json, http::StatusCode, response::IntoResponse}; @@ -875,6 +878,7 @@ pub mod endpoint { use crate::callers::song::song_queue; + /// Endpoint to queue a song. Starts the process and places the song in a queue #[utoipa::path( post, path = "/song/queue",