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>
go-gitea · Sep 18, 2021 · 0b368aa · 0b368aa
1 parent 2553365
commit 0b368aa
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 10 deletions.
diff --git 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
@@ -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"
           },