OpenAPI: correct documentation of issue listing parameters (#17060)

* correct documentation of issue listing parameters

* make generate-swagger

Co-authored-by: Lauris BH <lauris@nix.lv>
Co-authored-by: techknowlogick <techknowlogick@gitea.io>
tokarchuk/v1.17
Norwin 3 years ago committed by GitHub
parent 25533657f6
commit 0b368aa73d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 10
      routers/api/v1/repo/issue.go
  2. 10
      templates/swagger/v1_json.tmpl

@ -317,27 +317,27 @@ func ListIssues(ctx *context.APIContext) {
// type: string // type: string
// - name: since // - name: since
// in: query // in: query
// description: Only show notifications updated after the given time. This is a timestamp in RFC 3339 format // description: Only show items updated after the given time. This is a timestamp in RFC 3339 format
// type: string // type: string
// format: date-time // format: date-time
// required: false // required: false
// - name: before // - name: before
// in: query // in: query
// description: Only show notifications updated before the given time. This is a timestamp in RFC 3339 format // description: Only show items updated before the given time. This is a timestamp in RFC 3339 format
// type: string // type: string
// format: date-time // format: date-time
// required: false // required: false
// - name: created_by // - name: created_by
// in: query // in: query
// description: filter (issues / pulls) created to // description: Only show items which were created by the the given user
// type: string // type: string
// - name: assigned_by // - name: assigned_by
// in: query // in: query
// description: filter (issues / pulls) assigned to // description: Only show items for which the given user is assigned
// type: string // type: string
// - name: mentioned_by // - name: mentioned_by
// in: query // in: query
// description: filter (issues / pulls) mentioning to // description: Only show items in which the given user was mentioned
// type: string // type: string
// - name: page // - name: page
// in: query // in: query

@ -4334,32 +4334,32 @@
{ {
"type": "string", "type": "string",
"format": "date-time", "format": "date-time",
"description": "Only show notifications updated after the given time. This is a timestamp in RFC 3339 format", "description": "Only show items updated after the given time. This is a timestamp in RFC 3339 format",
"name": "since", "name": "since",
"in": "query" "in": "query"
}, },
{ {
"type": "string", "type": "string",
"format": "date-time", "format": "date-time",
"description": "Only show notifications updated before the given time. This is a timestamp in RFC 3339 format", "description": "Only show items updated before the given time. This is a timestamp in RFC 3339 format",
"name": "before", "name": "before",
"in": "query" "in": "query"
}, },
{ {
"type": "string", "type": "string",
"description": "filter (issues / pulls) created to", "description": "Only show items which were created by the the given user",
"name": "created_by", "name": "created_by",
"in": "query" "in": "query"
}, },
{ {
"type": "string", "type": "string",
"description": "filter (issues / pulls) assigned to", "description": "Only show items for which the given user is assigned",
"name": "assigned_by", "name": "assigned_by",
"in": "query" "in": "query"
}, },
{ {
"type": "string", "type": "string",
"description": "filter (issues / pulls) mentioning to", "description": "Only show items in which the given user was mentioned",
"name": "mentioned_by", "name": "mentioned_by",
"in": "query" "in": "query"
}, },

Loading…
Cancel
Save