Add better Swagger description and a example for GetArchive (#12743)

Co-authored-by: techknowlogick <techknowlogick@gitea.io>
5 years ago · 3408fb73b6
parent 43c303d35c
commit 3408fb73b6
2 changed files with 2 additions and 2 deletions
--- a/routers/api/v1/repo/file.go
+++ b/routers/api/v1/repo/file.go
@ -87,7 +87,7 @@ func GetArchive(ctx *context.APIContext) {
 	//   required: true
 	// - name: archive
 	//   in: path
-	//   description: archive to download, consisting of a git reference and archive
+	//   description: the git reference for download with attached archive format (e.g. master.zip)
 	//   type: string
 	//   required: true
 	// responses:
--- a/templates/swagger/v1_json.tmpl
+++ b/templates/swagger/v1_json.tmpl
@ -2075,7 +2075,7 @@
          },
          {
            "type": "string",
-            "description": "archive to download, consisting of a git reference and archive",
+            "description": "the git reference for download with attached archive format (e.g. master.zip)",
            "name": "archive",
            "in": "path",
            "required": true