Browse Source

add simple descriptions for file API responses (#4089)

* 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>
tags/v1.21.12.1
stevegt Lunny Xiao 7 years ago
parent
commit
39f2aa7c12
2 changed files with 15 additions and 6 deletions
  1. +9
    -3
      public/swagger.v1.json
  2. +6
    -3
      routers/api/v1/repo/file.go

+ 9
- 3
public/swagger.v1.json View File

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


+ 6
- 3
routers/api/v1/repo/file.go View File

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


Loading…
Cancel
Save