tsk-170: API documentation #178

Merged
kdeng00 merged 13 commits from tsk-170 into v0.2 2025-08-24 19:58:38 -04:00
Showing only changes of commit 96be29a818 - Show all commits
+4
View File
@@ -117,9 +117,11 @@ pub mod request {
pub mod response { pub mod response {
use serde::{Deserialize, Serialize}; use serde::{Deserialize, Serialize};
/// Song queue response
#[derive(Default, Deserialize, Serialize, utoipa::ToSchema)] #[derive(Default, Deserialize, Serialize, utoipa::ToSchema)]
pub struct Response { pub struct Response {
pub message: String, pub message: String,
/// Id of the queued song
pub data: Vec<uuid::Uuid>, pub data: Vec<uuid::Uuid>,
} }
@@ -867,6 +869,7 @@ mod song_queue {
} }
} }
/// Module for song related endpoints
pub mod endpoint { pub mod endpoint {
use axum::{Json, http::StatusCode, response::IntoResponse}; use axum::{Json, http::StatusCode, response::IntoResponse};
@@ -875,6 +878,7 @@ pub mod endpoint {
use crate::callers::song::song_queue; use crate::callers::song::song_queue;
/// Endpoint to queue a song. Starts the process and places the song in a queue
#[utoipa::path( #[utoipa::path(
post, post,
path = "/song/queue", path = "/song/queue",