vikarti.anatra/polaris-mirror
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Utoipa for file browser endpoints

Browse source
This commit is contained in:
Antoine Gersant 2025-01-14 22:42:40 -08:00
parent 23facd96b9
commit 07e8077a38
2 changed files with 41 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

38
src/server/axum/api.rs
View file

@ -39,10 +39,10 @@ pub fn router() -> OpenApiRouter<App> {
.routes(routes!(delete_user, put_user)) .routes(routes!(delete_user, put_user))
.routes(routes!(get_users)) .routes(routes!(get_users))
// File browser // File browser
.route("/browse", get(get_browse_root)) .routes(routes!(get_browse_root))
.route("/browse/{*path}", get(get_browse)) .routes(routes!(get_browse))
.route("/flatten", get(get_flatten_root)) .routes(routes!(get_flatten_root))
.route("/flatten/{*path}", get(get_flatten)) .routes(routes!(get_flatten))
// Semantic // Semantic
.route("/albums", get(get_albums)) .route("/albums", get(get_albums))
.route("/albums/recent", get(get_recent_albums)) .route("/albums/recent", get(get_recent_albums))
@ -410,6 +410,13 @@ fn albums_to_response(albums: Vec<index::Album>, api_version: APIMajorVersion) -
} }
} }
#[utoipa::path(
get,
path = "/browse",
responses(
(status = 200, body = Vec<dto::BrowserEntry>),
)
)]
async fn get_browse_root( async fn get_browse_root(
_auth: Auth, _auth: Auth,
api_version: APIMajorVersion, api_version: APIMajorVersion,
@ -422,6 +429,14 @@ async fn get_browse_root(
index_files_to_response(result, api_version) index_files_to_response(result, api_version)
} }
#[utoipa::path(
get,
path = "/browse/{*path}",
params(("path" = String, Path, allow_reserved)),
responses(
(status = 200, body = Vec<dto::BrowserEntry>),
)
)]
async fn get_browse( async fn get_browse(
_auth: Auth, _auth: Auth,
api_version: APIMajorVersion, api_version: APIMajorVersion,
@ -435,6 +450,13 @@ async fn get_browse(
index_files_to_response(result, api_version) index_files_to_response(result, api_version)
} }
#[utoipa::path(
get,
path = "/flatten",
responses(
(status = 200, body = dto::SongList),
)
)]
async fn get_flatten_root( async fn get_flatten_root(
_auth: Auth, _auth: Auth,
api_version: APIMajorVersion, api_version: APIMajorVersion,
@ -448,6 +470,14 @@ async fn get_flatten_root(
song_list_to_response(song_list, api_version) song_list_to_response(song_list, api_version)
} }
#[utoipa::path(
get,
path = "/flatten/{*path}",
params(("path" = String, Path, allow_reserved)),
responses(
(status = 200, body = dto::SongList),
)
)]
async fn get_flatten( async fn get_flatten(
_auth: Auth, _auth: Auth,
api_version: APIMajorVersion, api_version: APIMajorVersion,

10
src/server/dto/v8.rs
View file

@ -214,8 +214,9 @@ impl From<scanner::Status> for IndexStatus {
} }
} }
#[derive(Debug, PartialEq, Eq, Serialize, Deserialize)] #[derive(Debug, PartialEq, Eq, Serialize, Deserialize, ToSchema)]
pub struct Song { pub struct Song {
#[schema(value_type = String)]
pub path: PathBuf, pub path: PathBuf,
#[serde(default, skip_serializing_if = "Option::is_none")] #[serde(default, skip_serializing_if = "Option::is_none")]
pub track_number: Option<i64>, pub track_number: Option<i64>,
@ -231,6 +232,7 @@ pub struct Song {
pub year: Option<i64>, pub year: Option<i64>,
#[serde(default, skip_serializing_if = "Option::is_none")] #[serde(default, skip_serializing_if = "Option::is_none")]
pub album: Option<String>, pub album: Option<String>,
#[schema(value_type = Option<String>)]
#[serde(default, skip_serializing_if = "Option::is_none")] #[serde(default, skip_serializing_if = "Option::is_none")]
pub artwork: Option<PathBuf>, pub artwork: Option<PathBuf>,
#[serde(default, skip_serializing_if = "Option::is_none")] #[serde(default, skip_serializing_if = "Option::is_none")]
@ -266,14 +268,16 @@ impl From<index::Song> for Song {
} }
} }
#[derive(Debug, PartialEq, Eq, Serialize, Deserialize)] #[derive(Debug, PartialEq, Eq, Serialize, Deserialize, ToSchema)]
pub struct SongList { pub struct SongList {
#[schema(value_type = Vec<String>)]
pub paths: Vec<PathBuf>, pub paths: Vec<PathBuf>,
pub first_songs: Vec<Song>, pub first_songs: Vec<Song>,
} }
#[derive(Debug, PartialEq, Eq, Serialize, Deserialize)] #[derive(Debug, PartialEq, Eq, Serialize, Deserialize, ToSchema)]
pub struct BrowserEntry { pub struct BrowserEntry {
#[schema(value_type = String)]
pub path: PathBuf, pub path: PathBuf,
pub is_directory: bool, pub is_directory: bool,
} }