diff options
| author | Norwin <noerw@users.noreply.github.com> | 2021-09-18 03:01:50 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-09-17 21:01:50 -0400 |
| commit | 0b368aa73d54eca0d30de3c4a580eadadabbe3e3 (patch) | |
| tree | ebbe0c7b08600adaacba1bcda3a55a75ae67423a | |
| parent | 25533657f6a3edd2d12c8b8112d009559a136201 (diff) | |
| download | gitea-0b368aa73d54eca0d30de3c4a580eadadabbe3e3.tar.gz gitea-0b368aa73d54eca0d30de3c4a580eadadabbe3e3.zip | |
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>
| -rw-r--r-- | routers/api/v1/repo/issue.go | 10 | ||||
| -rw-r--r-- | templates/swagger/v1_json.tmpl | 10 |
2 files changed, 10 insertions, 10 deletions
diff --git a/routers/api/v1/repo/issue.go b/routers/api/v1/repo/issue.go index e8ef2f3d05..c576d18e5f 100644 --- a/routers/api/v1/repo/issue.go +++ b/routers/api/v1/repo/issue.go @@ -317,27 +317,27 @@ func ListIssues(ctx *context.APIContext) { // type: string // - name: since // 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 // format: date-time // required: false // - name: before // 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 // format: date-time // required: false // - name: created_by // in: query - // description: filter (issues / pulls) created to + // description: Only show items which were created by the the given user // type: string // - name: assigned_by // in: query - // description: filter (issues / pulls) assigned to + // description: Only show items for which the given user is assigned // type: string // - name: mentioned_by // in: query - // description: filter (issues / pulls) mentioning to + // description: Only show items in which the given user was mentioned // type: string // - name: page // in: query diff --git a/templates/swagger/v1_json.tmpl b/templates/swagger/v1_json.tmpl index 9b5f059504..69081777dc 100644 --- a/templates/swagger/v1_json.tmpl +++ b/templates/swagger/v1_json.tmpl @@ -4334,32 +4334,32 @@ { "type": "string", "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", "in": "query" }, { "type": "string", "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", "in": "query" }, { "type": "string", - "description": "filter (issues / pulls) created to", + "description": "Only show items which were created by the the given user", "name": "created_by", "in": "query" }, { "type": "string", - "description": "filter (issues / pulls) assigned to", + "description": "Only show items for which the given user is assigned", "name": "assigned_by", "in": "query" }, { "type": "string", - "description": "filter (issues / pulls) mentioning to", + "description": "Only show items in which the given user was mentioned", "name": "mentioned_by", "in": "query" }, |