diff options
| author | 6543 <6543@obermui.de> | 2020-09-06 18:23:47 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-09-06 12:23:47 -0400 |
| commit | 3408fb73b67a4ef4687fa95098bc476f486fe220 (patch) | |
| tree | 38b3ceb77b537fd399bb08f3ed871a550c611732 | |
| parent | 43c303d35c74562bf2eaf221d46f7ef1539179a6 (diff) | |
| download | gitea-3408fb73b67a4ef4687fa95098bc476f486fe220.tar.gz gitea-3408fb73b67a4ef4687fa95098bc476f486fe220.zip | |
Add better Swagger description and a example for GetArchive (#12743)
Co-authored-by: techknowlogick <techknowlogick@gitea.io>
| -rw-r--r-- | routers/api/v1/repo/file.go | 2 | ||||
| -rw-r--r-- | 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 |