Sansan/MusicServer
1
0 Fork 0
Code Issues 9 Pull Requests 1 Actions Packages Projects Releases Wiki Activity

Add OpenAPI/Swagger documentation #18

New Issue
Closed
opened 2026-06-08 20:06:32 +02:00 by Sansan · 0 comments
Sansan commented 2026-06-08 20:06:32 +02:00
Owner
Copy link
Copy source

Add Swag annotations to all handler endpoints for OpenAPI documentation generation. Added /openapi endpoint that serves the swagger.json file directly. This enables API documentation and client generation.

Add Swag annotations to all handler endpoints for OpenAPI documentation generation. Added /openapi endpoint that serves the swagger.json file directly. This enables API documentation and client generation.
Sansan added this to the 5.0.0 milestone 2026-06-08 20:06:32 +02:00
Sansan added the feature label 2026-06-08 20:06:32 +02:00
Sansan self-assigned this 2026-09-26 17:03:08 +02:00
Sign in to join this conversation.
No Branch/Tag Specified
Labels
Clear labels
area/api
Routes, auth, OpenAPI and downloads
 area/library
Soundtracks, songs, sync, uploads and covers
 area/music
Queue, random songs and playing
 area/statistics
Statistics endpoints
 area/vgmq
The VGMQ game mode
 blocked
Waits on another issue or a release
 bug
Something does not work
 duplicate
Already covered by another issue or pull request
 feature
New behavior or endpoints
 maintenance
Refactors, dependency updates and migrations
 ops
Deploying, Unraid and monitoring
 wontfix
Will not be done
No labels feature
Milestone
No items
No Milestone 5.0.0
Projects
Clear projects
No projects
Assignees
Clear assignees
Sansan
No Assignees Sansan
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: Sansan/MusicServer#18