Skip to content

Commit 6998ba4

Browse files
committed
enhance swagger docs
1 parent f6030da commit 6998ba4

File tree

2 files changed

+30
-17
lines changed

2 files changed

+30
-17
lines changed

routers/api/v1/repo/pull.go

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -52,54 +52,60 @@ func ListPullRequests(ctx *context.APIContext) {
5252
// parameters:
5353
// - name: owner
5454
// in: path
55-
// description: owner of the repo
55+
// description: Owner of the repo
5656
// type: string
5757
// required: true
5858
// - name: repo
5959
// in: path
60-
// description: name of the repo
60+
// description: Name of the repo
6161
// type: string
6262
// required: true
6363
// - name: state
6464
// in: query
65-
// description: "State of pull request: open or closed (optional)"
65+
// description: State of pull request
6666
// type: string
67-
// enum: [closed, open, all]
67+
// enum: [open, closed, all]
68+
// default: open
6869
// - name: sort
6970
// in: query
70-
// description: "Type of sort"
71+
// description: Type of sort
7172
// type: string
7273
// enum: [oldest, recentupdate, leastupdate, mostcomment, leastcomment, priority]
7374
// - name: milestone
7475
// in: query
75-
// description: "ID of the milestone"
76+
// description: ID of the milestone
7677
// type: integer
7778
// format: int64
7879
// - name: labels
7980
// in: query
80-
// description: "Label IDs"
81+
// description: Label IDs
8182
// type: array
8283
// collectionFormat: multi
8384
// items:
8485
// type: integer
8586
// format: int64
8687
// - name: owner
8788
// in: query
88-
// description: filter by owner
89+
// description: Filter by pull request author
8990
// type: string
9091
// - name: page
9192
// in: query
92-
// description: page number of results to return (1-based)
93+
// description: Page number of results to return (1-based)
9394
// type: integer
95+
// minimum: 1
96+
// default: 1
9497
// - name: limit
9598
// in: query
96-
// description: page size of results
99+
// description: Page size of results
97100
// type: integer
101+
// minimum: 0
98102
// responses:
99103
// "200":
100104
// "$ref": "#/responses/PullRequestList"
101105
// "404":
102106
// "$ref": "#/responses/notFound"
107+
// "500":
108+
// "$ref": "#/responses/error"
103109

104110
labelIDs, err := base.StringsToInt64s(ctx.FormStrings("labels"))
105111
if err != nil {

templates/swagger/v1_json.tmpl

Lines changed: 14 additions & 7 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)