fedi/forgejo
1
0
Fork 0
mirror of https://codeberg.org/forgejo/forgejo.git synced 2024-11-29 07:46:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

add simple descriptions for file API responses (#4089)

Browse source 
* Partial fix for #4010

Swagger needs a description field in each swagger:operation response.  Adding
minimal text for now on the way to getting swagger validate to pass.  Many
standard swagger client libraries will not work with gitea until validate
passes, so prioritizing that over better descriptions for now.

Signed-off-by: Steve Traugott <stevegt@t7a.org>
This commit is contained in:
stevegt 2018-05-31 22:51:49 -07:00 committed by Lunny Xiao
parent 7707ad7a0a
commit 39f2aa7c12
2 changed files with 15 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
public/swagger.v1.json vendored
View file

@ -1028,7 +1028,9 @@
} }
], ],
"responses": { "responses": {
"200": {} "200": {
"description": "success"
}
} }
} }
}, },
@ -1338,7 +1340,9 @@
} }
], ],
"responses": { "responses": {
"200": {} "200": {
"description": "success"
}
} }
} }
}, },
@ -3261,7 +3265,9 @@
} }
], ],
"responses": { "responses": {
"200": {} "200": {
"description": "success"
}
} }
} }
}, },

9
routers/api/v1/repo/file.go
View file

@ -36,7 +36,8 @@ func GetRawFile(ctx *context.APIContext) {
// type: string // type: string
// required: true // required: true
// responses: // responses:
// 200: // 200:
// description: success
if !ctx.Repo.HasAccess() { if !ctx.Repo.HasAccess() {
ctx.Status(404) ctx.Status(404)
return return
@ -85,7 +86,8 @@ func GetArchive(ctx *context.APIContext) {
// type: string // type: string
// required: true // required: true
// responses: // responses:
// 200: // 200:
// description: success
repoPath := models.RepoPath(ctx.Params(":username"), ctx.Params(":reponame")) repoPath := models.RepoPath(ctx.Params(":username"), ctx.Params(":reponame"))
gitRepo, err := git.OpenRepository(repoPath) gitRepo, err := git.OpenRepository(repoPath)
if err != nil { if err != nil {
@ -121,7 +123,8 @@ func GetEditorconfig(ctx *context.APIContext) {
// type: string // type: string
// required: true // required: true
// responses: // responses:
// 200: // 200:
// description: success
ec, err := ctx.Repo.GetEditorconfig() ec, err := ctx.Repo.GetEditorconfig()
if err != nil { if err != nil {
if git.IsErrNotExist(err) { if git.IsErrNotExist(err) {