Skip to content

Commit 9228542

Browse files
committed
doc: add "Audio streaming" tag
1 parent 37f9869 commit 9228542

File tree

1 file changed

+14
-6
lines changed
  • rust/src/visualization/streaming

1 file changed

+14
-6
lines changed

rust/src/visualization/streaming/audio.rs

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ pub struct SpectralDataResponse {
155155
/// Returns information about the audio stream including frame rates,
156156
/// subscriber count, and other metrics.
157157
#[deprecated(note = "Use /api/stream/audio/fast/stats for more efficient binary streaming")]
158-
#[openapi_protect_get("/api/stream/stats", "read:api")]
158+
#[openapi_protect_get("/api/stream/stats", "read:api", tag = "Audio Streaming")]
159159
pub async fn get_stream_stats(stream_state: &State<AudioStreamState>) -> Json<StreamStats> {
160160
let stats = stream_state.stream.get_stats().await;
161161
Json(stats)
@@ -165,7 +165,7 @@ pub async fn get_stream_stats(stream_state: &State<AudioStreamState>) -> Json<St
165165
///
166166
/// Returns information about the audio stream including frame rates,
167167
/// subscriber count, and other metrics.
168-
#[openapi_protect_get("/api/stream/audio/fast/stats", "read:api")]
168+
#[openapi_protect_get("/api/stream/audio/fast/stats", "read:api", tag = "Audio Streaming")]
169169
pub async fn get_stream_fast_stats(stream_state: &State<AudioStreamState>) -> Json<StreamStats> {
170170
let stats = stream_state.stream.get_stats().await;
171171
Json(stats)
@@ -175,7 +175,7 @@ pub async fn get_stream_fast_stats(stream_state: &State<AudioStreamState>) -> Js
175175
///
176176
/// Returns the most recent audio frame without subscribing to the stream.
177177
/// Useful for getting current state or testing connectivity.
178-
#[openapi_protect_get("/api/stream/latest", "read:api")]
178+
#[openapi_protect_get("/api/stream/latest", "read:api", tag = "Audio Streaming")]
179179
pub async fn get_latest_frame(
180180
stream_state: &State<AudioStreamState>,
181181
) -> Option<Json<AudioFrameResponse>> {
@@ -446,7 +446,7 @@ pub struct StreamingNodeInfo {
446446
/// }
447447
/// ]
448448
/// ```
449-
#[openapi_protect_get("/api/stream/nodes", "read:api")]
449+
#[openapi_protect_get("/api/stream/nodes", "read:api", tag = "Audio Streaming")]
450450
pub async fn list_streaming_nodes(
451451
stream_state: &State<AudioStreamState>,
452452
) -> Json<Vec<StreamingNodeInfo>> {
@@ -484,7 +484,11 @@ pub async fn list_streaming_nodes(
484484
#[deprecated(
485485
note = "Use /api/stream/audio/fast/<node_id>/stats for more efficient binary streaming with node routing"
486486
)]
487-
#[openapi_protect_get("/api/stream/nodes/<node_id>/stats", "read:api")]
487+
#[openapi_protect_get(
488+
"/api/stream/nodes/<node_id>/stats",
489+
"read:api",
490+
tag = "Audio Streaming"
491+
)]
488492
pub async fn get_node_stats(
489493
node_id: &str,
490494
stream_state: &State<AudioStreamState>,
@@ -499,7 +503,11 @@ pub async fn get_node_stats(
499503
///
500504
/// ### Authentication
501505
/// Requires a valid JWT token with `read:api` permission.
502-
#[openapi_protect_get("/api/stream/audio/fast/<node_id>/stats", "read:api")]
506+
#[openapi_protect_get(
507+
"/api/stream/audio/fast/<node_id>/stats",
508+
"read:api",
509+
tag = "Audio Streaming"
510+
)]
503511
pub async fn get_node_fast_stats(
504512
node_id: &str,
505513
stream_state: &State<AudioStreamState>,

0 commit comments

Comments
 (0)