Skip to content

Fix docs #66

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
DutchJavaDev merged 2 commits into from
Sep 6, 2025
Merged

Fix docs #66

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6865a02
typo in doc
DutchJavaDev Sep 6, 2025
a4cfe49
kinda fixed path
DutchJavaDev Sep 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion MyMusicBoxApi/docs/docs.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ const docTemplate = `{
"host": "{{.Host}}",
"basePath": "{{.BasePath}}",
"paths": {
"/api/v1/download:sourceId": {
"/api/v1/download": {
"get": {
"description": "Enables playback for song/file using http 206 partial content",
"produces": [
Expand Down
2 changes: 1 addition & 1 deletion MyMusicBoxApi/docs/swagger.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
},
"basePath": "/api/v1",
"paths": {
"/api/v1/download:sourceId": {
"/api/v1/download": {
"get": {
"description": "Enables playback for song/file using http 206 partial content",
"produces": [
Expand Down
2 changes: 1 addition & 1 deletion MyMusicBoxApi/docs/swagger.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ info:
title: MusicBoxApi API
version: "1.0"
paths:
/api/v1/download:sourceId:
/api/v1/download:
get:
description: Enables playback for song/file using http 206 partial content
parameters:
Expand Down
7 changes: 5 additions & 2 deletions MyMusicBoxApi/generate_docs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
#!/bin/bash

# need to fix gopath...
sudo /root/go/bin/swag init
# yml to readme
# https://swagger-markdown-ui.netlify.app/

# works for me
sudo $HOME/go/bin/swag init
2 changes: 1 addition & 1 deletion MyMusicBoxApi/http/download.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ import (
// @Success 200 "serve song/file with range request (http 206)"
// @Success 0 {object} models.DownloadRequestModel
// @Failure 500 {object} models.ApiResponseModel
// @Router /api/v1/download:sourceId [get]
// @Router /api/v1/download [get]
func DownloadRequest(ctx *gin.Context) {
var request models.DownloadRequestModel
err := ctx.ShouldBindBodyWithJSON(&request)
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This project aims to create not just a music player but a universal music search
## Version: 1.0


### /api/v1/download:sourceId
### /api/v1/download

#### GET
##### Description:
Expand Down