Skip to content

Commit 4b947c9

Browse files
authored
chore(docs): update docs with new head_sha filter for the "List workflows runs for a repository" (GET /repos/{owner}/{repo}/actions/runs) and "List workflow runs [for a workflow]" (GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs ) APIs (#547)
WIP octokit/openapi updated
1 parent 71d7ee7 commit 4b947c9

File tree

3 files changed

+37
-1
lines changed

3 files changed

+37
-1
lines changed

docs/actions/listWorkflowRuns.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,11 @@ If `true` pull requests are omitted from the response (empty array).
9090

9191
Returns workflow runs with the `check_suite_id` that you specify.
9292

93+
</td></tr>
94+
<tr><td>head_sha</td><td>no</td><td>
95+
96+
Only returns workflow runs that are associated with the specified `head_sha`.
97+
9398
</td></tr>
9499
</tbody>
95100
</table>

docs/actions/listWorkflowRunsForRepo.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,11 @@ If `true` pull requests are omitted from the response (empty array).
8484

8585
Returns workflow runs with the `check_suite_id` that you specify.
8686

87+
</td></tr>
88+
<tr><td>head_sha</td><td>no</td><td>
89+
90+
Only returns workflow runs that are associated with the specified `head_sha`.
91+
8792
</td></tr>
8893
</tbody>
8994
</table>

scripts/update-endpoints/generated/endpoints.json

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5221,6 +5221,19 @@
52215221
"validation": null,
52225222
"alias": null,
52235223
"deprecated": null
5224+
},
5225+
{
5226+
"name": "head_sha",
5227+
"description": "Only returns workflow runs that are associated with the specified `head_sha`.",
5228+
"in": "QUERY",
5229+
"type": "string",
5230+
"required": false,
5231+
"enum": null,
5232+
"allowNull": false,
5233+
"mapToData": null,
5234+
"validation": null,
5235+
"alias": null,
5236+
"deprecated": null
52245237
}
52255238
],
52265239
"responses": [
@@ -5406,6 +5419,19 @@
54065419
"validation": null,
54075420
"alias": null,
54085421
"deprecated": null
5422+
},
5423+
{
5424+
"name": "head_sha",
5425+
"description": "Only returns workflow runs that are associated with the specified `head_sha`.",
5426+
"in": "QUERY",
5427+
"type": "string",
5428+
"required": false,
5429+
"enum": null,
5430+
"allowNull": false,
5431+
"mapToData": null,
5432+
"validation": null,
5433+
"alias": null,
5434+
"deprecated": null
54095435
}
54105436
],
54115437
"responses": [
@@ -26689,7 +26715,7 @@
2668926715
"in": "BODY",
2669026716
"type": "string",
2669126717
"required": false,
26692-
"enum": null,
26718+
"enum": ["completed", "not_planned", "reopened"],
2669326719
"allowNull": true,
2669426720
"mapToData": null,
2669526721
"validation": null,

0 commit comments

Comments
 (0)