Skip to content

OpenAPI: correct documentation of issue listing parameters #17060

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Sep 18, 2021
Merged

OpenAPI: correct documentation of issue listing parameters #17060

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
9ac6549
correct documentation of issue listing parameters
noerw Sep 15, 2021
fd61f89
make generate-swagger
noerw Sep 15, 2021
9949775
Merge branch 'main' into swagger-docs-improvements
lafriks Sep 16, 2021
e724d49
Merge branch 'main' into swagger-docs-improvements
techknowlogick Sep 16, 2021
a988e04
Merge branch 'main' into swagger-docs-improvements
techknowlogick Sep 16, 2021
51047b1
Merge branch 'main' into swagger-docs-improvements
lafriks Sep 17, 2021
dc57956
Merge branch 'main' into swagger-docs-improvements
techknowlogick Sep 18, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions routers/api/v1/repo/issue.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 5 additions & 5 deletions templates/swagger/v1_json.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
},
Expand Down