Skip to content

Commit dc1c3a5

Browse files
committed
Update swagger description
1 parent 9634f56 commit dc1c3a5

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

routers/api/v1/repo/file.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -604,7 +604,7 @@ func GetContentsList(ctx *context.APIContext) {
604604
func GetFileHistory(ctx *context.APIContext) {
605605
// swagger:operation GET /repos/{owner}/{repo}/git/history/{filepath} repository repoGetFileHistory
606606
// ---
607-
// summary: Get a file's commit history
607+
// summary: Get a file's or directory's commit history
608608
// produces:
609609
// - application/json
610610
// parameters:
@@ -620,12 +620,12 @@ func GetFileHistory(ctx *context.APIContext) {
620620
// required: true
621621
// - name: filepath
622622
// in: path
623-
// description: filepath of the file to get
623+
// description: filepath of the file/directory
624624
// type: string
625625
// required: true
626626
// - name: ref
627627
// in: query
628-
// description: "The name of the commit/branch/tag. Default the repository’s default branch (usually master)"
628+
// description: "The name of the branch. Default the repository’s default branch (usually master)"
629629
// type: string
630630
// required: false
631631
// - name: page

templates/swagger/v1_json.tmpl

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3660,7 +3660,7 @@
36603660
"tags": [
36613661
"repository"
36623662
],
3663-
"summary": "Get a file's commit history",
3663+
"summary": "Get a file's or directory's commit history",
36643664
"operationId": "repoGetFileHistory",
36653665
"parameters": [
36663666
{
@@ -3679,14 +3679,14 @@
36793679
},
36803680
{
36813681
"type": "string",
3682-
"description": "filepath of the file to get",
3682+
"description": "filepath of the file/directory",
36833683
"name": "filepath",
36843684
"in": "path",
36853685
"required": true
36863686
},
36873687
{
36883688
"type": "string",
3689-
"description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)",
3689+
"description": "The name of the branch. Default the repository’s default branch (usually master)",
36903690
"name": "ref",
36913691
"in": "query"
36923692
},

0 commit comments

Comments
 (0)