diff --git a/lib/rest/static/decorated/api.github.com.json b/lib/rest/static/decorated/api.github.com.json index c82322056b7f..9333f5f0ec3c 100644 --- a/lib/rest/static/decorated/api.github.com.json +++ b/lib/rest/static/decorated/api.github.com.json @@ -34625,6 +34625,121 @@ } ] }, + { + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "run_id", + "description": "The id of the workflow run.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

The id of the workflow run.

" + }, + { + "name": "attempt_number", + "description": "The attempt number of the workflow run.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

The attempt number of the workflow run.

" + }, + { + "name": "per_page", + "description": "Results per page (max 100)", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "descriptionHTML": "

Results per page (max 100)

" + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "descriptionHTML": "

Page number of the results to fetch.

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/runs/42/attempts/42/jobs", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/runs/42/attempts/42/jobs
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs', {\n owner: 'octocat',\n repo: 'hello-world',\n run_id: 42,\n attempt_number: 42\n})", + "html": "
await octokit.request('GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  run_id: 42,\n  attempt_number: 42\n})\n
" + } + ], + "summary": "List jobs for a workflow run attempt", + "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).", + "tags": [ + "actions" + ], + "operationId": "actions/list-jobs-for-workflow-run-attempt", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#list-jobs-for-a-workflow-run-attempt" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "workflow-jobs" + }, + "slug": "list-jobs-for-a-workflow-run-attempt", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "workflow-jobs", + "subcategoryLabel": "Workflow jobs", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

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.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
{\n  \"total_count\": 1,\n  \"jobs\": [\n    {\n      \"id\": 399444496,\n      \"run_id\": 29679449,\n      \"run_url\": \"https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449\",\n      \"node_id\": \"MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==\",\n      \"head_sha\": \"f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0\",\n      \"url\": \"https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496\",\n      \"html_url\": \"https://github.com/octo-org/octo-repo/runs/399444496\",\n      \"status\": \"completed\",\n      \"conclusion\": \"success\",\n      \"started_at\": \"2020-01-20T17:42:40Z\",\n      \"completed_at\": \"2020-01-20T17:44:39Z\",\n      \"name\": \"build\",\n      \"steps\": [\n        {\n          \"name\": \"Set up job\",\n          \"status\": \"completed\",\n          \"conclusion\": \"success\",\n          \"number\": 1,\n          \"started_at\": \"2020-01-20T09:42:40.000-08:00\",\n          \"completed_at\": \"2020-01-20T09:42:41.000-08:00\"\n        },\n        {\n          \"name\": \"Run actions/checkout@v2\",\n          \"status\": \"completed\",\n          \"conclusion\": \"success\",\n          \"number\": 2,\n          \"started_at\": \"2020-01-20T09:42:41.000-08:00\",\n          \"completed_at\": \"2020-01-20T09:42:45.000-08:00\"\n        },\n        {\n          \"name\": \"Set up Ruby\",\n          \"status\": \"completed\",\n          \"conclusion\": \"success\",\n          \"number\": 3,\n          \"started_at\": \"2020-01-20T09:42:45.000-08:00\",\n          \"completed_at\": \"2020-01-20T09:42:45.000-08:00\"\n        },\n        {\n          \"name\": \"Run actions/cache@v2\",\n          \"status\": \"completed\",\n          \"conclusion\": \"success\",\n          \"number\": 4,\n          \"started_at\": \"2020-01-20T09:42:45.000-08:00\",\n          \"completed_at\": \"2020-01-20T09:42:48.000-08:00\"\n        },\n        {\n          \"name\": \"Install Bundler\",\n          \"status\": \"completed\",\n          \"conclusion\": \"success\",\n          \"number\": 5,\n          \"started_at\": \"2020-01-20T09:42:48.000-08:00\",\n          \"completed_at\": \"2020-01-20T09:42:52.000-08:00\"\n        },\n        {\n          \"name\": \"Install Gems\",\n          \"status\": \"completed\",\n          \"conclusion\": \"success\",\n          \"number\": 6,\n          \"started_at\": \"2020-01-20T09:42:52.000-08:00\",\n          \"completed_at\": \"2020-01-20T09:42:53.000-08:00\"\n        },\n        {\n          \"name\": \"Run Tests\",\n          \"status\": \"completed\",\n          \"conclusion\": \"success\",\n          \"number\": 7,\n          \"started_at\": \"2020-01-20T09:42:53.000-08:00\",\n          \"completed_at\": \"2020-01-20T09:42:59.000-08:00\"\n        },\n        {\n          \"name\": \"Deploy to Heroku\",\n          \"status\": \"completed\",\n          \"conclusion\": \"success\",\n          \"number\": 8,\n          \"started_at\": \"2020-01-20T09:42:59.000-08:00\",\n          \"completed_at\": \"2020-01-20T09:44:39.000-08:00\"\n        },\n        {\n          \"name\": \"Post actions/cache@v2\",\n          \"status\": \"completed\",\n          \"conclusion\": \"success\",\n          \"number\": 16,\n          \"started_at\": \"2020-01-20T09:44:39.000-08:00\",\n          \"completed_at\": \"2020-01-20T09:44:39.000-08:00\"\n        },\n        {\n          \"name\": \"Complete job\",\n          \"status\": \"completed\",\n          \"conclusion\": \"success\",\n          \"number\": 17,\n          \"started_at\": \"2020-01-20T09:44:39.000-08:00\",\n          \"completed_at\": \"2020-01-20T09:44:39.000-08:00\"\n        }\n      ],\n      \"check_run_url\": \"https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496\",\n      \"labels\": [\n        \"self-hosted\",\n        \"foo\",\n        \"bar\"\n      ],\n      \"runner_id\": 1,\n      \"runner_name\": \"my runner\",\n      \"runner_group_id\": 2,\n      \"runner_group_name\": \"my runner group\"\n    }\n  ]\n}\n
" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + } + ] + }, { "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs", @@ -74936,6 +75051,11 @@ "httpStatusMessage": "Created", "description": "Response for successful upload", "payload": "
{\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\n  \"browser_download_url\": \"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\n  \"id\": 1,\n  \"node_id\": \"MDEyOlJlbGVhc2VBc3NldDE=\",\n  \"name\": \"example.zip\",\n  \"label\": \"short description\",\n  \"state\": \"uploaded\",\n  \"content_type\": \"application/zip\",\n  \"size\": 1024,\n  \"download_count\": 42,\n  \"created_at\": \"2013-02-27T19:35:32Z\",\n  \"updated_at\": \"2013-02-27T19:35:32Z\",\n  \"uploader\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  }\n}\n
" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Response if you upload an asset with the same filename as another uploaded asset" } ] }, diff --git a/lib/rest/static/decorated/ghes-2.22.json b/lib/rest/static/decorated/ghes-2.22.json index 7cf45346bf90..8faaeba7a1a2 100644 --- a/lib/rest/static/decorated/ghes-2.22.json +++ b/lib/rest/static/decorated/ghes-2.22.json @@ -65978,6 +65978,11 @@ "httpStatusMessage": "Created", "description": "Response for successful upload", "payload": "
{\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\n  \"browser_download_url\": \"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\n  \"id\": 1,\n  \"node_id\": \"MDEyOlJlbGVhc2VBc3NldDE=\",\n  \"name\": \"example.zip\",\n  \"label\": \"short description\",\n  \"state\": \"uploaded\",\n  \"content_type\": \"application/zip\",\n  \"size\": 1024,\n  \"download_count\": 42,\n  \"created_at\": \"2013-02-27T19:35:32Z\",\n  \"updated_at\": \"2013-02-27T19:35:32Z\",\n  \"uploader\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  }\n}\n
" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Response if you upload an asset with the same filename as another uploaded asset" } ] }, diff --git a/lib/rest/static/decorated/ghes-3.0.json b/lib/rest/static/decorated/ghes-3.0.json index 2327ce7805a5..4916798ce393 100644 --- a/lib/rest/static/decorated/ghes-3.0.json +++ b/lib/rest/static/decorated/ghes-3.0.json @@ -70781,6 +70781,11 @@ "httpStatusMessage": "Created", "description": "Response for successful upload", "payload": "
{\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\n  \"browser_download_url\": \"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\n  \"id\": 1,\n  \"node_id\": \"MDEyOlJlbGVhc2VBc3NldDE=\",\n  \"name\": \"example.zip\",\n  \"label\": \"short description\",\n  \"state\": \"uploaded\",\n  \"content_type\": \"application/zip\",\n  \"size\": 1024,\n  \"download_count\": 42,\n  \"created_at\": \"2013-02-27T19:35:32Z\",\n  \"updated_at\": \"2013-02-27T19:35:32Z\",\n  \"uploader\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  }\n}\n
" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Response if you upload an asset with the same filename as another uploaded asset" } ] }, diff --git a/lib/rest/static/decorated/ghes-3.1.json b/lib/rest/static/decorated/ghes-3.1.json index 319958f8fc07..95e6dc7c681c 100644 --- a/lib/rest/static/decorated/ghes-3.1.json +++ b/lib/rest/static/decorated/ghes-3.1.json @@ -71471,6 +71471,11 @@ "httpStatusMessage": "Created", "description": "Response for successful upload", "payload": "
{\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\n  \"browser_download_url\": \"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\n  \"id\": 1,\n  \"node_id\": \"MDEyOlJlbGVhc2VBc3NldDE=\",\n  \"name\": \"example.zip\",\n  \"label\": \"short description\",\n  \"state\": \"uploaded\",\n  \"content_type\": \"application/zip\",\n  \"size\": 1024,\n  \"download_count\": 42,\n  \"created_at\": \"2013-02-27T19:35:32Z\",\n  \"updated_at\": \"2013-02-27T19:35:32Z\",\n  \"uploader\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  }\n}\n
" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Response if you upload an asset with the same filename as another uploaded asset" } ] }, diff --git a/lib/rest/static/decorated/ghes-3.2.json b/lib/rest/static/decorated/ghes-3.2.json index d08018ba6057..02d47808727b 100644 --- a/lib/rest/static/decorated/ghes-3.2.json +++ b/lib/rest/static/decorated/ghes-3.2.json @@ -73661,6 +73661,11 @@ "httpStatusMessage": "Created", "description": "Response for successful upload", "payload": "
{\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\n  \"browser_download_url\": \"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\n  \"id\": 1,\n  \"node_id\": \"MDEyOlJlbGVhc2VBc3NldDE=\",\n  \"name\": \"example.zip\",\n  \"label\": \"short description\",\n  \"state\": \"uploaded\",\n  \"content_type\": \"application/zip\",\n  \"size\": 1024,\n  \"download_count\": 42,\n  \"created_at\": \"2013-02-27T19:35:32Z\",\n  \"updated_at\": \"2013-02-27T19:35:32Z\",\n  \"uploader\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  }\n}\n
" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Response if you upload an asset with the same filename as another uploaded asset" } ] }, diff --git a/lib/rest/static/decorated/github.ae.json b/lib/rest/static/decorated/github.ae.json index 744c44a2eace..faeaf0d0bce2 100644 --- a/lib/rest/static/decorated/github.ae.json +++ b/lib/rest/static/decorated/github.ae.json @@ -26928,6 +26928,121 @@ } ] }, + { + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs", + "serverUrl": "https://{hostname}/api/v3", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "run_id", + "description": "The id of the workflow run.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

The id of the workflow run.

" + }, + { + "name": "attempt_number", + "description": "The attempt number of the workflow run.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

The attempt number of the workflow run.

" + }, + { + "name": "per_page", + "description": "Results per page (max 100)", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "descriptionHTML": "

Results per page (max 100)

" + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "descriptionHTML": "

Page number of the results to fetch.

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://{hostname}/api/v3/repos/octocat/hello-world/actions/runs/42/attempts/42/jobs", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://{hostname}/api/v3/repos/octocat/hello-world/actions/runs/42/attempts/42/jobs
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs', {\n owner: 'octocat',\n repo: 'hello-world',\n run_id: 42,\n attempt_number: 42\n})", + "html": "
await octokit.request('GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  run_id: 42,\n  attempt_number: 42\n})\n
" + } + ], + "summary": "List jobs for a workflow run attempt", + "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/github-ae@latest/rest/overview/resources-in-the-rest-api#parameters).", + "tags": [ + "actions" + ], + "operationId": "actions/list-jobs-for-workflow-run-attempt", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#list-jobs-for-a-workflow-run-attempt" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "workflow-jobs" + }, + "slug": "list-jobs-for-a-workflow-run-attempt", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "workflow-jobs", + "subcategoryLabel": "Workflow jobs", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

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.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
{\n  \"total_count\": 1,\n  \"jobs\": [\n    {\n      \"id\": 399444496,\n      \"run_id\": 29679449,\n      \"run_url\": \"https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449\",\n      \"node_id\": \"MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==\",\n      \"head_sha\": \"f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0\",\n      \"url\": \"https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496\",\n      \"html_url\": \"https://github.com/octo-org/octo-repo/runs/399444496\",\n      \"status\": \"completed\",\n      \"conclusion\": \"success\",\n      \"started_at\": \"2020-01-20T17:42:40Z\",\n      \"completed_at\": \"2020-01-20T17:44:39Z\",\n      \"name\": \"build\",\n      \"steps\": [\n        {\n          \"name\": \"Set up job\",\n          \"status\": \"completed\",\n          \"conclusion\": \"success\",\n          \"number\": 1,\n          \"started_at\": \"2020-01-20T09:42:40.000-08:00\",\n          \"completed_at\": \"2020-01-20T09:42:41.000-08:00\"\n        },\n        {\n          \"name\": \"Run actions/checkout@v2\",\n          \"status\": \"completed\",\n          \"conclusion\": \"success\",\n          \"number\": 2,\n          \"started_at\": \"2020-01-20T09:42:41.000-08:00\",\n          \"completed_at\": \"2020-01-20T09:42:45.000-08:00\"\n        },\n        {\n          \"name\": \"Set up Ruby\",\n          \"status\": \"completed\",\n          \"conclusion\": \"success\",\n          \"number\": 3,\n          \"started_at\": \"2020-01-20T09:42:45.000-08:00\",\n          \"completed_at\": \"2020-01-20T09:42:45.000-08:00\"\n        },\n        {\n          \"name\": \"Run actions/cache@v2\",\n          \"status\": \"completed\",\n          \"conclusion\": \"success\",\n          \"number\": 4,\n          \"started_at\": \"2020-01-20T09:42:45.000-08:00\",\n          \"completed_at\": \"2020-01-20T09:42:48.000-08:00\"\n        },\n        {\n          \"name\": \"Install Bundler\",\n          \"status\": \"completed\",\n          \"conclusion\": \"success\",\n          \"number\": 5,\n          \"started_at\": \"2020-01-20T09:42:48.000-08:00\",\n          \"completed_at\": \"2020-01-20T09:42:52.000-08:00\"\n        },\n        {\n          \"name\": \"Install Gems\",\n          \"status\": \"completed\",\n          \"conclusion\": \"success\",\n          \"number\": 6,\n          \"started_at\": \"2020-01-20T09:42:52.000-08:00\",\n          \"completed_at\": \"2020-01-20T09:42:53.000-08:00\"\n        },\n        {\n          \"name\": \"Run Tests\",\n          \"status\": \"completed\",\n          \"conclusion\": \"success\",\n          \"number\": 7,\n          \"started_at\": \"2020-01-20T09:42:53.000-08:00\",\n          \"completed_at\": \"2020-01-20T09:42:59.000-08:00\"\n        },\n        {\n          \"name\": \"Deploy to Heroku\",\n          \"status\": \"completed\",\n          \"conclusion\": \"success\",\n          \"number\": 8,\n          \"started_at\": \"2020-01-20T09:42:59.000-08:00\",\n          \"completed_at\": \"2020-01-20T09:44:39.000-08:00\"\n        },\n        {\n          \"name\": \"Post actions/cache@v2\",\n          \"status\": \"completed\",\n          \"conclusion\": \"success\",\n          \"number\": 16,\n          \"started_at\": \"2020-01-20T09:44:39.000-08:00\",\n          \"completed_at\": \"2020-01-20T09:44:39.000-08:00\"\n        },\n        {\n          \"name\": \"Complete job\",\n          \"status\": \"completed\",\n          \"conclusion\": \"success\",\n          \"number\": 17,\n          \"started_at\": \"2020-01-20T09:44:39.000-08:00\",\n          \"completed_at\": \"2020-01-20T09:44:39.000-08:00\"\n        }\n      ],\n      \"check_run_url\": \"https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496\",\n      \"labels\": [\n        \"self-hosted\",\n        \"foo\",\n        \"bar\"\n      ],\n      \"runner_id\": 1,\n      \"runner_name\": \"my runner\",\n      \"runner_group_id\": 2,\n      \"runner_group_name\": \"my runner group\"\n    }\n  ]\n}\n
" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + } + ] + }, { "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs", @@ -64212,6 +64327,11 @@ "httpStatusMessage": "Created", "description": "Response for successful upload", "payload": "
{\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\n  \"browser_download_url\": \"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\n  \"id\": 1,\n  \"node_id\": \"MDEyOlJlbGVhc2VBc3NldDE=\",\n  \"name\": \"example.zip\",\n  \"label\": \"short description\",\n  \"state\": \"uploaded\",\n  \"content_type\": \"application/zip\",\n  \"size\": 1024,\n  \"download_count\": 42,\n  \"created_at\": \"2013-02-27T19:35:32Z\",\n  \"updated_at\": \"2013-02-27T19:35:32Z\",\n  \"uploader\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  }\n}\n
" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Response if you upload an asset with the same filename as another uploaded asset" } ] }, diff --git a/lib/rest/static/dereferenced/api.github.com.deref.json b/lib/rest/static/dereferenced/api.github.com.deref.json index c61c04816bbf..be0d439d5a16 100644 --- a/lib/rest/static/dereferenced/api.github.com.deref.json +++ b/lib/rest/static/dereferenced/api.github.com.deref.json @@ -141562,6 +141562,448 @@ } } }, + "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs": { + "get": { + "summary": "List jobs for a workflow run attempt", + "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).", + "tags": [ + "actions" + ], + "operationId": "actions/list-jobs-for-workflow-run-attempt", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#list-jobs-for-a-workflow-run-attempt" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "run_id", + "description": "The id of the workflow run.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "attempt_number", + "description": "The attempt number of the workflow run.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "per_page", + "description": "Results per page (max 100)", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "jobs" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "jobs": { + "type": "array", + "items": { + "title": "Job", + "description": "Information of a job execution in a workflow run", + "type": "object", + "properties": { + "id": { + "description": "The id of the job.", + "example": 21, + "type": "integer" + }, + "run_id": { + "description": "The id of the associated workflow run.", + "example": 5, + "type": "integer" + }, + "run_url": { + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5" + }, + "run_attempt": { + "type": "integer", + "description": "Attempt number of the associated workflow run, 1 for first attempt and higher if the workflow was re-run.", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDg6Q2hlY2tSdW40" + }, + "head_sha": { + "description": "The SHA of the commit that is being run.", + "example": "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d", + "type": "string" + }, + "url": { + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/jobs/21" + }, + "html_url": { + "type": "string", + "example": "https://github.com/github/hello-world/runs/4", + "nullable": true + }, + "status": { + "description": "The phase of the lifecycle that the job is currently in.", + "example": "queued", + "type": "string", + "enum": [ + "queued", + "in_progress", + "completed" + ] + }, + "conclusion": { + "description": "The outcome of the job.", + "example": "success", + "type": "string", + "nullable": true + }, + "started_at": { + "description": "The time that the job started, in ISO 8601 format.", + "example": "2019-08-08T08:00:00-07:00", + "format": "date-time", + "type": "string" + }, + "completed_at": { + "description": "The time that the job finished, in ISO 8601 format.", + "example": "2019-08-08T08:00:00-07:00", + "format": "date-time", + "type": "string", + "nullable": true + }, + "name": { + "description": "The name of the job.", + "example": "test-coverage", + "type": "string" + }, + "steps": { + "description": "Steps in this job.", + "type": "array", + "items": { + "type": "object", + "required": [ + "name", + "status", + "conclusion", + "number" + ], + "properties": { + "status": { + "description": "The phase of the lifecycle that the job is currently in.", + "example": "queued", + "type": "string", + "enum": [ + "queued", + "in_progress", + "completed" + ] + }, + "conclusion": { + "description": "The outcome of the job.", + "example": "success", + "type": "string", + "nullable": true + }, + "name": { + "description": "The name of the job.", + "example": "test-coverage", + "type": "string" + }, + "number": { + "type": "integer", + "example": 1 + }, + "started_at": { + "description": "The time that the step started, in ISO 8601 format.", + "example": "2019-08-08T08:00:00-07:00", + "format": "date-time", + "type": "string", + "nullable": true + }, + "completed_at": { + "description": "The time that the job finished, in ISO 8601 format.", + "example": "2019-08-08T08:00:00-07:00", + "format": "date-time", + "type": "string", + "nullable": true + } + } + } + }, + "check_run_url": { + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/check-runs/4" + }, + "labels": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Labels for the workflow job. Specified by the \"runs_on\" attribute in the action's workflow file.", + "example": [ + "self-hosted", + "foo", + "bar" + ] + }, + "runner_id": { + "type": "integer", + "nullable": true, + "example": 1, + "description": "The ID of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)" + }, + "runner_name": { + "type": "string", + "nullable": true, + "example": "my runner", + "description": "The name of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)" + }, + "runner_group_id": { + "type": "integer", + "nullable": true, + "example": 2, + "description": "The ID of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)" + }, + "runner_group_name": { + "type": "string", + "nullable": true, + "example": "my runner group", + "description": "The name of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)" + } + }, + "required": [ + "id", + "node_id", + "run_id", + "run_url", + "head_sha", + "name", + "url", + "html_url", + "status", + "conclusion", + "started_at", + "completed_at", + "check_run_url", + "labels", + "runner_id", + "runner_name", + "runner_group_id", + "runner_group_name" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 1, + "jobs": [ + { + "id": 399444496, + "run_id": 29679449, + "run_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449", + "node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==", + "head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0", + "url": "https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496", + "html_url": "https://github.com/octo-org/octo-repo/runs/399444496", + "status": "completed", + "conclusion": "success", + "started_at": "2020-01-20T17:42:40Z", + "completed_at": "2020-01-20T17:44:39Z", + "name": "build", + "steps": [ + { + "name": "Set up job", + "status": "completed", + "conclusion": "success", + "number": 1, + "started_at": "2020-01-20T09:42:40.000-08:00", + "completed_at": "2020-01-20T09:42:41.000-08:00" + }, + { + "name": "Run actions/checkout@v2", + "status": "completed", + "conclusion": "success", + "number": 2, + "started_at": "2020-01-20T09:42:41.000-08:00", + "completed_at": "2020-01-20T09:42:45.000-08:00" + }, + { + "name": "Set up Ruby", + "status": "completed", + "conclusion": "success", + "number": 3, + "started_at": "2020-01-20T09:42:45.000-08:00", + "completed_at": "2020-01-20T09:42:45.000-08:00" + }, + { + "name": "Run actions/cache@v2", + "status": "completed", + "conclusion": "success", + "number": 4, + "started_at": "2020-01-20T09:42:45.000-08:00", + "completed_at": "2020-01-20T09:42:48.000-08:00" + }, + { + "name": "Install Bundler", + "status": "completed", + "conclusion": "success", + "number": 5, + "started_at": "2020-01-20T09:42:48.000-08:00", + "completed_at": "2020-01-20T09:42:52.000-08:00" + }, + { + "name": "Install Gems", + "status": "completed", + "conclusion": "success", + "number": 6, + "started_at": "2020-01-20T09:42:52.000-08:00", + "completed_at": "2020-01-20T09:42:53.000-08:00" + }, + { + "name": "Run Tests", + "status": "completed", + "conclusion": "success", + "number": 7, + "started_at": "2020-01-20T09:42:53.000-08:00", + "completed_at": "2020-01-20T09:42:59.000-08:00" + }, + { + "name": "Deploy to Heroku", + "status": "completed", + "conclusion": "success", + "number": 8, + "started_at": "2020-01-20T09:42:59.000-08:00", + "completed_at": "2020-01-20T09:44:39.000-08:00" + }, + { + "name": "Post actions/cache@v2", + "status": "completed", + "conclusion": "success", + "number": 16, + "started_at": "2020-01-20T09:44:39.000-08:00", + "completed_at": "2020-01-20T09:44:39.000-08:00" + }, + { + "name": "Complete job", + "status": "completed", + "conclusion": "success", + "number": 17, + "started_at": "2020-01-20T09:44:39.000-08:00", + "completed_at": "2020-01-20T09:44:39.000-08:00" + } + ], + "check_run_url": "https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496", + "labels": [ + "self-hosted", + "foo", + "bar" + ], + "runner_id": 1, + "runner_name": "my runner", + "runner_group_id": 2, + "runner_group_name": "my runner group" + } + ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "workflow-jobs" + } + } + }, "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs": { "get": { "summary": "Download workflow run attempt logs", @@ -331431,6 +331873,9 @@ } } } + }, + "422": { + "description": "Response if you upload an asset with the same filename as another uploaded asset" } }, "x-github": { diff --git a/lib/rest/static/dereferenced/ghes-2.22.deref.json b/lib/rest/static/dereferenced/ghes-2.22.deref.json index 786a2d823308..680135e36402 100644 --- a/lib/rest/static/dereferenced/ghes-2.22.deref.json +++ b/lib/rest/static/dereferenced/ghes-2.22.deref.json @@ -294768,6 +294768,9 @@ } } } + }, + "422": { + "description": "Response if you upload an asset with the same filename as another uploaded asset" } }, "x-github": { diff --git a/lib/rest/static/dereferenced/ghes-3.0.deref.json b/lib/rest/static/dereferenced/ghes-3.0.deref.json index 45d76732d005..c4864e54ac4b 100644 --- a/lib/rest/static/dereferenced/ghes-3.0.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.0.deref.json @@ -301609,6 +301609,9 @@ } } } + }, + "422": { + "description": "Response if you upload an asset with the same filename as another uploaded asset" } }, "x-github": { diff --git a/lib/rest/static/dereferenced/ghes-3.1.deref.json b/lib/rest/static/dereferenced/ghes-3.1.deref.json index ca3e109c3e0e..c7b6ee435d8a 100644 --- a/lib/rest/static/dereferenced/ghes-3.1.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.1.deref.json @@ -305497,6 +305497,9 @@ } } } + }, + "422": { + "description": "Response if you upload an asset with the same filename as another uploaded asset" } }, "x-github": { diff --git a/lib/rest/static/dereferenced/ghes-3.2.deref.json b/lib/rest/static/dereferenced/ghes-3.2.deref.json index 1b101f6a226e..5c2d170a1caf 100644 --- a/lib/rest/static/dereferenced/ghes-3.2.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.2.deref.json @@ -312377,6 +312377,9 @@ } } } + }, + "422": { + "description": "Response if you upload an asset with the same filename as another uploaded asset" } }, "x-github": { diff --git a/lib/rest/static/dereferenced/github.ae.deref.json b/lib/rest/static/dereferenced/github.ae.deref.json index ad833af10dad..341e70907c99 100644 --- a/lib/rest/static/dereferenced/github.ae.deref.json +++ b/lib/rest/static/dereferenced/github.ae.deref.json @@ -96891,6 +96891,448 @@ } } }, + "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs": { + "get": { + "summary": "List jobs for a workflow run attempt", + "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/github-ae@latest/rest/overview/resources-in-the-rest-api#parameters).", + "tags": [ + "actions" + ], + "operationId": "actions/list-jobs-for-workflow-run-attempt", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#list-jobs-for-a-workflow-run-attempt" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "run_id", + "description": "The id of the workflow run.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "attempt_number", + "description": "The attempt number of the workflow run.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "per_page", + "description": "Results per page (max 100)", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "jobs" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "jobs": { + "type": "array", + "items": { + "title": "Job", + "description": "Information of a job execution in a workflow run", + "type": "object", + "properties": { + "id": { + "description": "The id of the job.", + "example": 21, + "type": "integer" + }, + "run_id": { + "description": "The id of the associated workflow run.", + "example": 5, + "type": "integer" + }, + "run_url": { + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5" + }, + "run_attempt": { + "type": "integer", + "description": "Attempt number of the associated workflow run, 1 for first attempt and higher if the workflow was re-run.", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDg6Q2hlY2tSdW40" + }, + "head_sha": { + "description": "The SHA of the commit that is being run.", + "example": "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d", + "type": "string" + }, + "url": { + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/jobs/21" + }, + "html_url": { + "type": "string", + "example": "https://github.com/github/hello-world/runs/4", + "nullable": true + }, + "status": { + "description": "The phase of the lifecycle that the job is currently in.", + "example": "queued", + "type": "string", + "enum": [ + "queued", + "in_progress", + "completed" + ] + }, + "conclusion": { + "description": "The outcome of the job.", + "example": "success", + "type": "string", + "nullable": true + }, + "started_at": { + "description": "The time that the job started, in ISO 8601 format.", + "example": "2019-08-08T08:00:00-07:00", + "format": "date-time", + "type": "string" + }, + "completed_at": { + "description": "The time that the job finished, in ISO 8601 format.", + "example": "2019-08-08T08:00:00-07:00", + "format": "date-time", + "type": "string", + "nullable": true + }, + "name": { + "description": "The name of the job.", + "example": "test-coverage", + "type": "string" + }, + "steps": { + "description": "Steps in this job.", + "type": "array", + "items": { + "type": "object", + "required": [ + "name", + "status", + "conclusion", + "number" + ], + "properties": { + "status": { + "description": "The phase of the lifecycle that the job is currently in.", + "example": "queued", + "type": "string", + "enum": [ + "queued", + "in_progress", + "completed" + ] + }, + "conclusion": { + "description": "The outcome of the job.", + "example": "success", + "type": "string", + "nullable": true + }, + "name": { + "description": "The name of the job.", + "example": "test-coverage", + "type": "string" + }, + "number": { + "type": "integer", + "example": 1 + }, + "started_at": { + "description": "The time that the step started, in ISO 8601 format.", + "example": "2019-08-08T08:00:00-07:00", + "format": "date-time", + "type": "string", + "nullable": true + }, + "completed_at": { + "description": "The time that the job finished, in ISO 8601 format.", + "example": "2019-08-08T08:00:00-07:00", + "format": "date-time", + "type": "string", + "nullable": true + } + } + } + }, + "check_run_url": { + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/check-runs/4" + }, + "labels": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Labels for the workflow job. Specified by the \"runs_on\" attribute in the action's workflow file.", + "example": [ + "self-hosted", + "foo", + "bar" + ] + }, + "runner_id": { + "type": "integer", + "nullable": true, + "example": 1, + "description": "The ID of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)" + }, + "runner_name": { + "type": "string", + "nullable": true, + "example": "my runner", + "description": "The name of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)" + }, + "runner_group_id": { + "type": "integer", + "nullable": true, + "example": 2, + "description": "The ID of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)" + }, + "runner_group_name": { + "type": "string", + "nullable": true, + "example": "my runner group", + "description": "The name of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)" + } + }, + "required": [ + "id", + "node_id", + "run_id", + "run_url", + "head_sha", + "name", + "url", + "html_url", + "status", + "conclusion", + "started_at", + "completed_at", + "check_run_url", + "labels", + "runner_id", + "runner_name", + "runner_group_id", + "runner_group_name" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 1, + "jobs": [ + { + "id": 399444496, + "run_id": 29679449, + "run_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449", + "node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==", + "head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0", + "url": "https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496", + "html_url": "https://github.com/octo-org/octo-repo/runs/399444496", + "status": "completed", + "conclusion": "success", + "started_at": "2020-01-20T17:42:40Z", + "completed_at": "2020-01-20T17:44:39Z", + "name": "build", + "steps": [ + { + "name": "Set up job", + "status": "completed", + "conclusion": "success", + "number": 1, + "started_at": "2020-01-20T09:42:40.000-08:00", + "completed_at": "2020-01-20T09:42:41.000-08:00" + }, + { + "name": "Run actions/checkout@v2", + "status": "completed", + "conclusion": "success", + "number": 2, + "started_at": "2020-01-20T09:42:41.000-08:00", + "completed_at": "2020-01-20T09:42:45.000-08:00" + }, + { + "name": "Set up Ruby", + "status": "completed", + "conclusion": "success", + "number": 3, + "started_at": "2020-01-20T09:42:45.000-08:00", + "completed_at": "2020-01-20T09:42:45.000-08:00" + }, + { + "name": "Run actions/cache@v2", + "status": "completed", + "conclusion": "success", + "number": 4, + "started_at": "2020-01-20T09:42:45.000-08:00", + "completed_at": "2020-01-20T09:42:48.000-08:00" + }, + { + "name": "Install Bundler", + "status": "completed", + "conclusion": "success", + "number": 5, + "started_at": "2020-01-20T09:42:48.000-08:00", + "completed_at": "2020-01-20T09:42:52.000-08:00" + }, + { + "name": "Install Gems", + "status": "completed", + "conclusion": "success", + "number": 6, + "started_at": "2020-01-20T09:42:52.000-08:00", + "completed_at": "2020-01-20T09:42:53.000-08:00" + }, + { + "name": "Run Tests", + "status": "completed", + "conclusion": "success", + "number": 7, + "started_at": "2020-01-20T09:42:53.000-08:00", + "completed_at": "2020-01-20T09:42:59.000-08:00" + }, + { + "name": "Deploy to Heroku", + "status": "completed", + "conclusion": "success", + "number": 8, + "started_at": "2020-01-20T09:42:59.000-08:00", + "completed_at": "2020-01-20T09:44:39.000-08:00" + }, + { + "name": "Post actions/cache@v2", + "status": "completed", + "conclusion": "success", + "number": 16, + "started_at": "2020-01-20T09:44:39.000-08:00", + "completed_at": "2020-01-20T09:44:39.000-08:00" + }, + { + "name": "Complete job", + "status": "completed", + "conclusion": "success", + "number": 17, + "started_at": "2020-01-20T09:44:39.000-08:00", + "completed_at": "2020-01-20T09:44:39.000-08:00" + } + ], + "check_run_url": "https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496", + "labels": [ + "self-hosted", + "foo", + "bar" + ], + "runner_id": 1, + "runner_name": "my runner", + "runner_group_id": 2, + "runner_group_name": "my runner group" + } + ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "workflow-jobs" + } + } + }, "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs": { "get": { "summary": "Download workflow run attempt logs", @@ -278856,6 +279298,9 @@ } } } + }, + "422": { + "description": "Response if you upload an asset with the same filename as another uploaded asset" } }, "x-github": {