Skip to content

Commit aeaa2c1

Browse files
committed
Update Swagger documentation for workflow runs API
Add missing query parameters to the Swagger documentation for the workflow runs listing endpoint to match GitHub's API: actor, branch, event, status, created, exclude_pull_requests, check_suite_id, and head_sha.
1 parent 18546ed commit aeaa2c1

File tree

2 files changed

+149
-0
lines changed

2 files changed

+149
-0
lines changed

routers/api/v1/repo/action.go

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1122,6 +1122,39 @@ func ActionsListWorkflowRuns(ctx *context.APIContext) {
11221122
// description: id of the workflow
11231123
// type: string
11241124
// required: true
1125+
// - name: actor
1126+
// in: query
1127+
// description: Returns someone's workflow runs. Use the login for the user who created the push associated with the check suite or workflow run.
1128+
// type: string
1129+
// - name: branch
1130+
// in: query
1131+
// description: Returns workflow runs associated with a branch. Use the name of the branch of the push.
1132+
// type: string
1133+
// - name: event
1134+
// in: query
1135+
// description: Returns workflow run triggered by the event you specify. For example, push, pull_request or issue.
1136+
// type: string
1137+
// - name: status
1138+
// in: query
1139+
// description: Returns workflow runs with the check run status or conclusion that you specify. Can be one of completed, action_required, cancelled, failure, neutral, skipped, stale, success, timed_out, in_progress, queued, requested, waiting, pending
1140+
// type: string
1141+
// - name: created
1142+
// in: query
1143+
// description: Returns workflow runs created within the given date-time range. For more information on the syntax, see "Understanding the search syntax".
1144+
// type: string
1145+
// - name: exclude_pull_requests
1146+
// in: query
1147+
// description: If true pull requests are omitted from the response (empty array).
1148+
// type: boolean
1149+
// default: false
1150+
// - name: check_suite_id
1151+
// in: query
1152+
// description: Returns workflow runs with the check_suite_id that you specify.
1153+
// type: integer
1154+
// - name: head_sha
1155+
// in: query
1156+
// description: Only returns workflow runs that are associated with the specified head_sha.
1157+
// type: string
11251158
// - name: page
11261159
// in: query
11271160
// description: page number of results to return (1-based)

templates/swagger/v1_json.tmpl

Lines changed: 116 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)