jprdonnelly/docs
1
0
Fork 0
mirror of synced 2026-01-08 12:01:53 -05:00
Code Issues Projects Releases Wiki Activity

Merge pull request #11026 from github/repo-sync

Browse Source 
repo sync
This commit is contained in:
Octomerger Bot
2021-10-10 07:30:21 -04:00
committed by GitHub
parent 9fc7d0fb0f 32345ddf73
commit defe4e47ba
12 changed files with 1162 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

120
lib/rest/static/decorated/api.github.com.json
View File

File diff suppressed because one or more lines are too long

5
lib/rest/static/decorated/ghes-2.22.json
View File

File diff suppressed because one or more lines are too long

5
lib/rest/static/decorated/ghes-3.0.json
View File

File diff suppressed because one or more lines are too long

5
lib/rest/static/decorated/ghes-3.1.json
View File

File diff suppressed because one or more lines are too long

5
lib/rest/static/decorated/ghes-3.2.json
View File

File diff suppressed because one or more lines are too long

120
lib/rest/static/decorated/github.ae.json
View File

File diff suppressed because one or more lines are too long

445
lib/rest/static/dereferenced/api.github.com.deref.json
View File

@@ -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": "<https://api.github.com/resource?page=2>; rel=\"next\", <https://api.github.com/resource?page=5>; 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": {

3
lib/rest/static/dereferenced/ghes-2.22.deref.json
View File

@@ -294768,6 +294768,9 @@
}
}
}
},
"422": {
"description": "Response if you upload an asset with the same filename as another uploaded asset"
}
},
"x-github": {

3
lib/rest/static/dereferenced/ghes-3.0.deref.json
View File

@@ -301609,6 +301609,9 @@
}
}
}
},
"422": {
"description": "Response if you upload an asset with the same filename as another uploaded asset"
}
},
"x-github": {

3
lib/rest/static/dereferenced/ghes-3.1.deref.json
View File

@@ -305497,6 +305497,9 @@
}
}
}
},
"422": {
"description": "Response if you upload an asset with the same filename as another uploaded asset"
}
},
"x-github": {

3
lib/rest/static/dereferenced/ghes-3.2.deref.json
View File

@@ -312377,6 +312377,9 @@
}
}
}
},
"422": {
"description": "Response if you upload an asset with the same filename as another uploaded asset"
}
},
"x-github": {

445
lib/rest/static/dereferenced/github.ae.deref.json
View File

@@ -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": "<https://api.github.com/resource?page=2>; rel=\"next\", <https://api.github.com/resource?page=5>; 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": {