Skip to content

Commit e8db533

Browse files
committed
Add better Swagger description and a example for GetArchive
1 parent a755e5a commit e8db533

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

routers/api/v1/repo/file.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ func GetArchive(ctx *context.APIContext) {
8787
// required: true
8888
// - name: archive
8989
// in: path
90-
// description: archive to download, consisting of a git reference and archive
90+
// description: the git reference for download with attached archive format (e.g. master.zip)
9191
// type: string
9292
// required: true
9393
// responses:

templates/swagger/v1_json.tmpl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2075,7 +2075,7 @@
20752075
},
20762076
{
20772077
"type": "string",
2078-
"description": "archive to download, consisting of a git reference and archive",
2078+
"description": "the git reference for download with attached archive format (e.g. master.zip)",
20792079
"name": "archive",
20802080
"in": "path",
20812081
"required": true

0 commit comments

Comments
 (0)