Skip to content

Commit 0b368aa

Browse files
noerwlafrikstechknowlogick
authored
OpenAPI: correct documentation of issue listing parameters (#17060)
* correct documentation of issue listing parameters * make generate-swagger Co-authored-by: Lauris BH <[email protected]> Co-authored-by: techknowlogick <[email protected]>
1 parent 2553365 commit 0b368aa

File tree

2 files changed

+10
-10
lines changed

2 files changed

+10
-10
lines changed

routers/api/v1/repo/issue.go

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -317,27 +317,27 @@ func ListIssues(ctx *context.APIContext) {
317317
// type: string
318318
// - name: since
319319
// in: query
320-
// description: Only show notifications updated after the given time. This is a timestamp in RFC 3339 format
320+
// description: Only show items updated after the given time. This is a timestamp in RFC 3339 format
321321
// type: string
322322
// format: date-time
323323
// required: false
324324
// - name: before
325325
// in: query
326-
// description: Only show notifications updated before the given time. This is a timestamp in RFC 3339 format
326+
// description: Only show items updated before the given time. This is a timestamp in RFC 3339 format
327327
// type: string
328328
// format: date-time
329329
// required: false
330330
// - name: created_by
331331
// in: query
332-
// description: filter (issues / pulls) created to
332+
// description: Only show items which were created by the the given user
333333
// type: string
334334
// - name: assigned_by
335335
// in: query
336-
// description: filter (issues / pulls) assigned to
336+
// description: Only show items for which the given user is assigned
337337
// type: string
338338
// - name: mentioned_by
339339
// in: query
340-
// description: filter (issues / pulls) mentioning to
340+
// description: Only show items in which the given user was mentioned
341341
// type: string
342342
// - name: page
343343
// in: query

templates/swagger/v1_json.tmpl

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4334,32 +4334,32 @@
43344334
{
43354335
"type": "string",
43364336
"format": "date-time",
4337-
"description": "Only show notifications updated after the given time. This is a timestamp in RFC 3339 format",
4337+
"description": "Only show items updated after the given time. This is a timestamp in RFC 3339 format",
43384338
"name": "since",
43394339
"in": "query"
43404340
},
43414341
{
43424342
"type": "string",
43434343
"format": "date-time",
4344-
"description": "Only show notifications updated before the given time. This is a timestamp in RFC 3339 format",
4344+
"description": "Only show items updated before the given time. This is a timestamp in RFC 3339 format",
43454345
"name": "before",
43464346
"in": "query"
43474347
},
43484348
{
43494349
"type": "string",
4350-
"description": "filter (issues / pulls) created to",
4350+
"description": "Only show items which were created by the the given user",
43514351
"name": "created_by",
43524352
"in": "query"
43534353
},
43544354
{
43554355
"type": "string",
4356-
"description": "filter (issues / pulls) assigned to",
4356+
"description": "Only show items for which the given user is assigned",
43574357
"name": "assigned_by",
43584358
"in": "query"
43594359
},
43604360
{
43614361
"type": "string",
4362-
"description": "filter (issues / pulls) mentioning to",
4362+
"description": "Only show items in which the given user was mentioned",
43634363
"name": "mentioned_by",
43644364
"in": "query"
43654365
},

0 commit comments

Comments
 (0)