Skip to content

Commit f7680ea

Browse files
authored
Merge pull request #619 from github/openapi-update-9dd50357ae91f678316b0a7946891bb7ae1d55593c5f5506f8d90fd011f40b39
Update OpenAPI Descriptions
2 parents d367531 + c76b490 commit f7680ea

24 files changed

+3498
-2110
lines changed

descriptions/api.github.com/api.github.com.json

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18797,6 +18797,89 @@
1879718797
}
1879818798
}
1879918799
},
18800+
"/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs": {
18801+
"get": {
18802+
"summary": "List jobs for a workflow run attempt",
18803+
"description": "Lists jobs for a specific workflow run attempt. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters).",
18804+
"tags": [
18805+
"actions"
18806+
],
18807+
"operationId": "actions/list-jobs-for-workflow-run-attempt",
18808+
"externalDocs": {
18809+
"description": "API method documentation",
18810+
"url": "https://docs.github.com/rest/reference/actions#list-jobs-for-a-workflow-run-attempt"
18811+
},
18812+
"parameters": [
18813+
{
18814+
"$ref": "#/components/parameters/owner"
18815+
},
18816+
{
18817+
"$ref": "#/components/parameters/repo"
18818+
},
18819+
{
18820+
"$ref": "#/components/parameters/run-id"
18821+
},
18822+
{
18823+
"$ref": "#/components/parameters/attempt-number"
18824+
},
18825+
{
18826+
"$ref": "#/components/parameters/per-page"
18827+
},
18828+
{
18829+
"$ref": "#/components/parameters/page"
18830+
}
18831+
],
18832+
"responses": {
18833+
"200": {
18834+
"description": "Response",
18835+
"content": {
18836+
"application/json": {
18837+
"schema": {
18838+
"type": "object",
18839+
"required": [
18840+
"total_count",
18841+
"jobs"
18842+
],
18843+
"properties": {
18844+
"total_count": {
18845+
"type": "integer"
18846+
},
18847+
"jobs": {
18848+
"type": "array",
18849+
"items": {
18850+
"$ref": "#/components/schemas/job"
18851+
}
18852+
}
18853+
}
18854+
},
18855+
"examples": {
18856+
"default": {
18857+
"$ref": "#/components/examples/job-paginated"
18858+
}
18859+
}
18860+
}
18861+
},
18862+
"headers": {
18863+
"Link": {
18864+
"$ref": "#/components/headers/link"
18865+
}
18866+
}
18867+
},
18868+
"404": {
18869+
"$ref": "#/components/responses/not_found"
18870+
}
18871+
},
18872+
"x-github": {
18873+
"githubCloudOnly": false,
18874+
"enabledForGitHubApps": true,
18875+
"previews": [
18876+
18877+
],
18878+
"category": "actions",
18879+
"subcategory": "workflow-jobs"
18880+
}
18881+
}
18882+
},
1880018883
"/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs": {
1880118884
"get": {
1880218885
"summary": "Download workflow run attempt logs",
@@ -39416,6 +39499,9 @@
3941639499
}
3941739500
}
3941839501
}
39502+
},
39503+
"422": {
39504+
"description": "Response if you upload an asset with the same filename as another uploaded asset"
3941939505
}
3942039506
},
3942139507
"x-github": {

descriptions/api.github.com/api.github.com.yaml

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13141,6 +13141,59 @@ paths:
1314113141
previews: []
1314213142
category: actions
1314313143
subcategory: workflow-runs
13144+
"/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs":
13145+
get:
13146+
summary: List jobs for a workflow run attempt
13147+
description: Lists jobs for a specific workflow run attempt. Anyone with read
13148+
access to the repository can use this endpoint. If the repository is private
13149+
you must use an access token with the `repo` scope. GitHub Apps must have
13150+
the `actions:read` permission to use this endpoint. You can use parameters
13151+
to narrow the list of results. For more information about using parameters,
13152+
see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters).
13153+
tags:
13154+
- actions
13155+
operationId: actions/list-jobs-for-workflow-run-attempt
13156+
externalDocs:
13157+
description: API method documentation
13158+
url: https://docs.github.com/rest/reference/actions#list-jobs-for-a-workflow-run-attempt
13159+
parameters:
13160+
- "$ref": "#/components/parameters/owner"
13161+
- "$ref": "#/components/parameters/repo"
13162+
- "$ref": "#/components/parameters/run-id"
13163+
- "$ref": "#/components/parameters/attempt-number"
13164+
- "$ref": "#/components/parameters/per-page"
13165+
- "$ref": "#/components/parameters/page"
13166+
responses:
13167+
'200':
13168+
description: Response
13169+
content:
13170+
application/json:
13171+
schema:
13172+
type: object
13173+
required:
13174+
- total_count
13175+
- jobs
13176+
properties:
13177+
total_count:
13178+
type: integer
13179+
jobs:
13180+
type: array
13181+
items:
13182+
"$ref": "#/components/schemas/job"
13183+
examples:
13184+
default:
13185+
"$ref": "#/components/examples/job-paginated"
13186+
headers:
13187+
Link:
13188+
"$ref": "#/components/headers/link"
13189+
'404':
13190+
"$ref": "#/components/responses/not_found"
13191+
x-github:
13192+
githubCloudOnly: false
13193+
enabledForGitHubApps: true
13194+
previews: []
13195+
category: actions
13196+
subcategory: workflow-jobs
1314413197
"/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs":
1314513198
get:
1314613199
summary: Download workflow run attempt logs
@@ -27751,6 +27804,9 @@ paths:
2775127804
examples:
2775227805
response-for-successful-upload:
2775327806
"$ref": "#/components/examples/release-asset-response-for-successful-upload"
27807+
'422':
27808+
description: Response if you upload an asset with the same filename as another
27809+
uploaded asset
2775427810
x-github:
2775527811
githubCloudOnly: false
2775627812
enabledForGitHubApps: true

0 commit comments

Comments
 (0)