From 3408fb73b67a4ef4687fa95098bc476f486fe220 Mon Sep 17 00:00:00 2001
From: 6543 <6543@obermui.de>
Date: Sun, 6 Sep 2020 18:23:47 +0200
Subject: [PATCH] Add better Swagger description and a example for GetArchive
(#12743)
Co-authored-by: techknowlogick <techknowlogick@gitea.io>
---
routers/api/v1/repo/file.go | 2 +-
templates/swagger/v1_json.tmpl | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/routers/api/v1/repo/file.go b/routers/api/v1/repo/file.go
index a43fdb074e..bc85fec630 100644
--- 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:
diff --git a/templates/swagger/v1_json.tmpl b/templates/swagger/v1_json.tmpl
index 8381ebe774..661005be24 100644
--- 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