From 32b015fab19539c9a569ec876815333f277ede81 Mon Sep 17 00:00:00 2001 From: github-openapi-bot Date: Tue, 21 Sep 2021 16:09:44 -0700 Subject: [PATCH] Update OpenAPI Descriptions --- .../api.github.com/api.github.com.json | 98 +++++++++-- .../api.github.com/api.github.com.yaml | 78 ++++++-- .../dereferenced/api.github.com.deref.json | 166 +++++++++++++++--- .../dereferenced/api.github.com.deref.yaml | 92 ++++++++-- .../dereferenced/ghes-2.18.deref.json | 29 +-- .../dereferenced/ghes-2.18.deref.yaml | 16 +- descriptions/ghes-2.18/ghes-2.18.json | 10 +- descriptions/ghes-2.18/ghes-2.18.yaml | 15 +- .../dereferenced/ghes-2.19.deref.json | 29 +-- .../dereferenced/ghes-2.19.deref.yaml | 16 +- descriptions/ghes-2.19/ghes-2.19.json | 10 +- descriptions/ghes-2.19/ghes-2.19.yaml | 15 +- .../dereferenced/ghes-2.20.deref.json | 29 +-- .../dereferenced/ghes-2.20.deref.yaml | 16 +- descriptions/ghes-2.20/ghes-2.20.json | 10 +- descriptions/ghes-2.20/ghes-2.20.yaml | 15 +- .../dereferenced/ghes-2.21.deref.json | 29 +-- .../dereferenced/ghes-2.21.deref.yaml | 16 +- descriptions/ghes-2.21/ghes-2.21.json | 10 +- descriptions/ghes-2.21/ghes-2.21.yaml | 15 +- .../dereferenced/ghes-2.22.deref.json | 66 ++++--- .../dereferenced/ghes-2.22.deref.yaml | 29 +-- descriptions/ghes-2.22/ghes-2.22.json | 25 +-- descriptions/ghes-2.22/ghes-2.22.yaml | 28 +-- .../ghes-3.0/dereferenced/ghes-3.0.deref.json | 66 ++++--- .../ghes-3.0/dereferenced/ghes-3.0.deref.yaml | 29 +-- descriptions/ghes-3.0/ghes-3.0.json | 25 +-- descriptions/ghes-3.0/ghes-3.0.yaml | 28 +-- .../ghes-3.1/dereferenced/ghes-3.1.deref.json | 66 ++++--- .../ghes-3.1/dereferenced/ghes-3.1.deref.yaml | 29 +-- descriptions/ghes-3.1/ghes-3.1.json | 25 +-- descriptions/ghes-3.1/ghes-3.1.yaml | 28 +-- .../ghes-3.2/dereferenced/ghes-3.2.deref.json | 66 ++++--- .../ghes-3.2/dereferenced/ghes-3.2.deref.yaml | 29 +-- descriptions/ghes-3.2/ghes-3.2.json | 25 +-- descriptions/ghes-3.2/ghes-3.2.yaml | 28 +-- .../dereferenced/github.ae.deref.json | 86 +++++---- .../dereferenced/github.ae.deref.yaml | 49 +++--- descriptions/github.ae/github.ae.json | 45 ++--- descriptions/github.ae/github.ae.yaml | 48 ++--- 40 files changed, 870 insertions(+), 664 deletions(-) diff --git a/descriptions/api.github.com/api.github.com.json b/descriptions/api.github.com/api.github.com.json index 5d5994a34b..e0b5bd11c7 100644 --- a/descriptions/api.github.com/api.github.com.json +++ b/descriptions/api.github.com/api.github.com.json @@ -19536,9 +19536,11 @@ "previews": [ ], + "deprecationDate": "2021-09-14", "category": "actions", "subcategory": "workflow-runs" - } + }, + "deprecated": true } }, "/repos/{owner}/{repo}/actions/runs/{run_id}/retry": { @@ -25414,7 +25416,7 @@ "properties": { "permission": { "type": "string", - "description": "The permission to grant the collaborator. **Only valid on organization-owned repositories.** Can be one of: \n\\* `pull` - can pull, but not push to or administer this repository. \n\\* `push` - can pull and push, but not administer this repository. \n\\* `admin` - can pull, push and administer this repository. \n\\* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. \n\\* `triage` - Recommended for contributors who need to proactively manage issues and pull requests without write access.", + "description": "The permission to grant the collaborator. **Only valid on organization-owned repositories.** Can be one of: \n\\* `pull` - can pull, but not push to or administer this repository. \n\\* `push` - can pull and push, but not administer this repository. \n\\* `admin` - can pull, push and administer this repository. \n\\* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. \n\\* `triage` - Recommended for contributors who need to proactively manage issues and pull requests without write access. \n\\* custom repository role name - Can assign a custom repository role if the owning organization has defined any.", "enum": [ "pull", "push", @@ -34176,20 +34178,12 @@ }, "410": { "$ref": "#/components/responses/gone" - }, - "415": { - "$ref": "#/components/responses/preview_header_missing" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [ - { - "required": true, - "name": "mockingbird", - "note": "The API to get issue timeline events is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-23-timeline-preview-api/) for full details. To access the API you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mockingbird-preview\n```" - }, { "required": false, "name": "starfox", @@ -34831,6 +34825,79 @@ } } }, + "/repos/{owner}/{repo}/lfs": { + "put": { + "summary": "Enable Git LFS for a repository", + "description": "**Note:** The Git LFS API endpoints are currently in beta and are subject to change.", + "operationId": "repos/enable-lfs-for-repo", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#enable-git-lfs-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "202": { + "$ref": "#/components/responses/accepted" + }, + "403": { + "description": "We will return a 403 with one of the following messages:\n\n- Git LFS support not enabled because Git LFS is globally disabled.\n- Git LFS support not enabled because Git LFS is disabled for the root repository in the network.\n- Git LFS support not enabled because Git LFS is disabled for ." + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [ + + ], + "category": "repos", + "subcategory": "lfs" + } + }, + "delete": { + "summary": "Disable Git LFS for a repository", + "description": "**Note:** The Git LFS API endpoints are currently in beta and are subject to change.", + "operationId": "repos/disable-lfs-for-repo", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#disable-git-lfs-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [ + + ], + "category": "repos", + "subcategory": "lfs" + } + } + }, "/repos/{owner}/{repo}/license": { "get": { "summary": "Get the license for a repository", @@ -63704,6 +63771,11 @@ "description": "The auto incrementing run number for the workflow run.", "example": 106 }, + "run_attempt": { + "type": "integer", + "description": "Attempt number of the run, 1 for first attempt and higher if the workflow was retried.", + "example": 1 + }, "event": { "type": "string", "example": "push" @@ -63777,6 +63849,12 @@ "type": "string", "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/rerun" }, + "previous_attempt_url": { + "nullable": true, + "description": "The URL to the previous attempted run of this workflow, if one exists.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3" + }, "workflow_url": { "description": "The URL to the workflow.", "type": "string", diff --git a/descriptions/api.github.com/api.github.com.yaml b/descriptions/api.github.com/api.github.com.yaml index 11727dc037..81f9f6e407 100644 --- a/descriptions/api.github.com/api.github.com.yaml +++ b/descriptions/api.github.com/api.github.com.yaml @@ -13906,8 +13906,10 @@ paths: githubCloudOnly: false enabledForGitHubApps: false previews: [] + deprecationDate: '2021-09-14' category: actions subcategory: workflow-runs + deprecated: true "/repos/{owner}/{repo}/actions/runs/{run_id}/retry": post: summary: Retry a workflow @@ -18249,7 +18251,9 @@ paths: \ \n\\* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. \n\\* `triage` - Recommended for contributors who need - to proactively manage issues and pull requests without write access." + to proactively manage issues and pull requests without write access. + \n\\* custom repository role name - Can assign a custom repository + role if the owning organization has defined any." enum: - pull - push @@ -24633,19 +24637,10 @@ paths: "$ref": "#/components/responses/not_found" '410': "$ref": "#/components/responses/gone" - '415': - "$ref": "#/components/responses/preview_header_missing" x-github: githubCloudOnly: false enabledForGitHubApps: true previews: - - required: true - name: mockingbird - note: |- - The API to get issue timeline events is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-23-timeline-preview-api/) for full details. To access the API you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header: - ```shell - application/vnd.github.mockingbird-preview - ``` - required: false name: starfox note: |- @@ -25062,6 +25057,58 @@ paths: previews: [] category: repos subcategory: + "/repos/{owner}/{repo}/lfs": + put: + summary: Enable Git LFS for a repository + description: "**Note:** The Git LFS API endpoints are currently in beta and + are subject to change." + operationId: repos/enable-lfs-for-repo + tags: + - repos + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/reference/repos#enable-git-lfs-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + responses: + '202': + "$ref": "#/components/responses/accepted" + '403': + description: |- + We will return a 403 with one of the following messages: + + - Git LFS support not enabled because Git LFS is globally disabled. + - Git LFS support not enabled because Git LFS is disabled for the root repository in the network. + - Git LFS support not enabled because Git LFS is disabled for . + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: repos + subcategory: lfs + delete: + summary: Disable Git LFS for a repository + description: "**Note:** The Git LFS API endpoints are currently in beta and + are subject to change." + operationId: repos/disable-lfs-for-repo + tags: + - repos + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/reference/repos#disable-git-lfs-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: repos + subcategory: lfs "/repos/{owner}/{repo}/license": get: summary: Get the license for a repository @@ -46340,6 +46387,11 @@ components: type: integer description: The auto incrementing run number for the workflow run. example: 106 + run_attempt: + type: integer + description: Attempt number of the run, 1 for first attempt and higher if + the workflow was retried. + example: 1 event: type: string example: push @@ -46397,6 +46449,12 @@ components: description: The URL to rerun the workflow run. type: string example: https://api.github.com/repos/github/hello-world/actions/runs/5/rerun + previous_attempt_url: + nullable: true + description: The URL to the previous attempted run of this workflow, if + one exists. + type: string + example: https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3 workflow_url: description: The URL to the workflow. type: string diff --git a/descriptions/api.github.com/dereferenced/api.github.com.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.deref.json index b4c6296330..9ec28d0df2 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.json @@ -129735,6 +129735,11 @@ "description": "The auto incrementing run number for the workflow run.", "example": 106 }, + "run_attempt": { + "type": "integer", + "description": "Attempt number of the run, 1 for first attempt and higher if the workflow was retried.", + "example": 1 + }, "event": { "type": "string", "example": "push" @@ -129897,6 +129902,12 @@ "type": "string", "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/rerun" }, + "previous_attempt_url": { + "nullable": true, + "description": "The URL to the previous attempted run of this workflow, if one exists.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3" + }, "workflow_url": { "description": "The URL to the workflow.", "type": "string", @@ -133623,6 +133634,11 @@ "description": "The auto incrementing run number for the workflow run.", "example": 106 }, + "run_attempt": { + "type": "integer", + "description": "Attempt number of the run, 1 for first attempt and higher if the workflow was retried.", + "example": 1 + }, "event": { "type": "string", "example": "push" @@ -133785,6 +133801,12 @@ "type": "string", "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/rerun" }, + "previous_attempt_url": { + "nullable": true, + "description": "The URL to the previous attempted run of this workflow, if one exists.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3" + }, "workflow_url": { "description": "The URL to the workflow.", "type": "string", @@ -139781,9 +139803,11 @@ "previews": [ ], + "deprecationDate": "2021-09-14", "category": "actions", "subcategory": "workflow-runs" - } + }, + "deprecated": true } }, "/repos/{owner}/{repo}/actions/runs/{run_id}/retry": { @@ -141219,6 +141243,11 @@ "description": "The auto incrementing run number for the workflow run.", "example": 106 }, + "run_attempt": { + "type": "integer", + "description": "Attempt number of the run, 1 for first attempt and higher if the workflow was retried.", + "example": 1 + }, "event": { "type": "string", "example": "push" @@ -141381,6 +141410,12 @@ "type": "string", "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/rerun" }, + "previous_attempt_url": { + "nullable": true, + "description": "The URL to the previous attempted run of this workflow, if one exists.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3" + }, "workflow_url": { "description": "The URL to the workflow.", "type": "string", @@ -177627,7 +177662,7 @@ "properties": { "permission": { "type": "string", - "description": "The permission to grant the collaborator. **Only valid on organization-owned repositories.** Can be one of: \n\\* `pull` - can pull, but not push to or administer this repository. \n\\* `push` - can pull and push, but not administer this repository. \n\\* `admin` - can pull, push and administer this repository. \n\\* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. \n\\* `triage` - Recommended for contributors who need to proactively manage issues and pull requests without write access.", + "description": "The permission to grant the collaborator. **Only valid on organization-owned repositories.** Can be one of: \n\\* `pull` - can pull, but not push to or administer this repository. \n\\* `push` - can pull and push, but not administer this repository. \n\\* `admin` - can pull, push and administer this repository. \n\\* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. \n\\* `triage` - Recommended for contributors who need to proactively manage issues and pull requests without write access. \n\\* custom repository role name - Can assign a custom repository role if the owning organization has defined any.", "enum": [ "pull", "push", @@ -278535,39 +278570,12 @@ } } } - }, - "415": { - "description": "Preview header missing", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [ - { - "required": true, - "name": "mockingbird", - "note": "The API to get issue timeline events is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-23-timeline-preview-api/) for full details. To access the API you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mockingbird-preview\n```" - }, { "required": false, "name": "starfox", @@ -279942,6 +279950,106 @@ } } }, + "/repos/{owner}/{repo}/lfs": { + "put": { + "summary": "Enable Git LFS for a repository", + "description": "**Note:** The Git LFS API endpoints are currently in beta and are subject to change.", + "operationId": "repos/enable-lfs-for-repo", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#enable-git-lfs-for-a-repository" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "202": { + "description": "Accepted", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "403": { + "description": "We will return a 403 with one of the following messages:\n\n- Git LFS support not enabled because Git LFS is globally disabled.\n- Git LFS support not enabled because Git LFS is disabled for the root repository in the network.\n- Git LFS support not enabled because Git LFS is disabled for ." + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [ + + ], + "category": "repos", + "subcategory": "lfs" + } + }, + "delete": { + "summary": "Disable Git LFS for a repository", + "description": "**Note:** The Git LFS API endpoints are currently in beta and are subject to change.", + "operationId": "repos/disable-lfs-for-repo", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#disable-git-lfs-for-a-repository" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [ + + ], + "category": "repos", + "subcategory": "lfs" + } + } + }, "/repos/{owner}/{repo}/license": { "get": { "summary": "Get the license for a repository", diff --git a/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml index 6dc735310c..3c744c59d6 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml @@ -30643,6 +30643,11 @@ paths: description: The auto incrementing run number for the workflow run. example: 106 + run_attempt: + type: integer + description: Attempt number of the run, 1 for first attempt + and higher if the workflow was retried. + example: 1 event: type: string example: push @@ -30763,6 +30768,12 @@ paths: description: The URL to rerun the workflow run. type: string example: https://api.github.com/repos/github/hello-world/actions/runs/5/rerun + previous_attempt_url: + nullable: true + description: The URL to the previous attempted run of this + workflow, if one exists. + type: string + example: https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3 workflow_url: description: The URL to the workflow. type: string @@ -32235,8 +32246,10 @@ paths: githubCloudOnly: false enabledForGitHubApps: false previews: [] + deprecationDate: '2021-09-14' category: actions subcategory: workflow-runs + deprecated: true "/repos/{owner}/{repo}/actions/runs/{run_id}/retry": post: summary: Retry a workflow @@ -41158,7 +41171,9 @@ paths: \ \n\\* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. \n\\* `triage` - Recommended for contributors who need - to proactively manage issues and pull requests without write access." + to proactively manage issues and pull requests without write access. + \n\\* custom repository role name - Can assign a custom repository + role if the owning organization has defined any." enum: - pull - push @@ -56726,20 +56741,10 @@ paths: '410': description: Gone content: *173 - '415': - description: Preview header missing - content: *19 x-github: githubCloudOnly: false enabledForGitHubApps: true previews: - - required: true - name: mockingbird - note: |- - The API to get issue timeline events is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-23-timeline-preview-api/) for full details. To access the API you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header: - ```shell - application/vnd.github.mockingbird-preview - ``` - required: false name: starfox note: |- @@ -57334,6 +57339,71 @@ paths: previews: [] category: repos subcategory: + "/repos/{owner}/{repo}/lfs": + put: + summary: Enable Git LFS for a repository + description: "**Note:** The Git LFS API endpoints are currently in beta and + are subject to change." + operationId: repos/enable-lfs-for-repo + tags: + - repos + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/reference/repos#enable-git-lfs-for-a-repository + parameters: + - name: owner + in: path + required: true + schema: *212 + - name: repo + in: path + required: true + schema: *213 + responses: + '202': + description: Accepted + content: *142 + '403': + description: |- + We will return a 403 with one of the following messages: + + - Git LFS support not enabled because Git LFS is globally disabled. + - Git LFS support not enabled because Git LFS is disabled for the root repository in the network. + - Git LFS support not enabled because Git LFS is disabled for . + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: repos + subcategory: lfs + delete: + summary: Disable Git LFS for a repository + description: "**Note:** The Git LFS API endpoints are currently in beta and + are subject to change." + operationId: repos/disable-lfs-for-repo + tags: + - repos + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/reference/repos#disable-git-lfs-for-a-repository + parameters: + - name: owner + in: path + required: true + schema: *212 + - name: repo + in: path + required: true + schema: *213 + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: repos + subcategory: lfs "/repos/{owner}/{repo}/license": get: summary: Get the license for a repository diff --git a/descriptions/ghes-2.18/dereferenced/ghes-2.18.deref.json b/descriptions/ghes-2.18/dereferenced/ghes-2.18.deref.json index f7e2b44084..6a22d50cac 100644 --- a/descriptions/ghes-2.18/dereferenced/ghes-2.18.deref.json +++ b/descriptions/ghes-2.18/dereferenced/ghes-2.18.deref.json @@ -102619,7 +102619,7 @@ "properties": { "permission": { "type": "string", - "description": "The permission to grant the collaborator. **Only valid on organization-owned repositories.** Can be one of: \n\\* `pull` - can pull, but not push to or administer this repository. \n\\* `push` - can pull and push, but not administer this repository. \n\\* `admin` - can pull, push and administer this repository. \n\\* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. \n\\* `triage` - Recommended for contributors who need to proactively manage issues and pull requests without write access.", + "description": "The permission to grant the collaborator. **Only valid on organization-owned repositories.** Can be one of: \n\\* `pull` - can pull, but not push to or administer this repository. \n\\* `push` - can pull and push, but not administer this repository. \n\\* `admin` - can pull, push and administer this repository. \n\\* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. \n\\* `triage` - Recommended for contributors who need to proactively manage issues and pull requests without write access. \n\\* custom repository role name - Can assign a custom repository role if the owning organization has defined any.", "enum": [ "pull", "push", @@ -196052,28 +196052,6 @@ } } } - }, - "415": { - "description": "Preview header missing", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } } }, "x-github": { @@ -196084,11 +196062,6 @@ "required": true, "name": "mockingbird", "note": "The API to get issue timeline events is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-23-timeline-preview-api/) for full details. To access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mockingbird-preview\n```" - }, - { - "required": false, - "name": "starfox", - "note": "Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the [blog post](https://developer.github.com/changes/2018-09-05-project-card-events).\n\nTo receive the `project_card` attribute, project boards must be [enabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) for a repository, and you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.starfox-preview+json\n```" } ], "category": "issues", diff --git a/descriptions/ghes-2.18/dereferenced/ghes-2.18.deref.yaml b/descriptions/ghes-2.18/dereferenced/ghes-2.18.deref.yaml index 9a1419c519..ae44895917 100644 --- a/descriptions/ghes-2.18/dereferenced/ghes-2.18.deref.yaml +++ b/descriptions/ghes-2.18/dereferenced/ghes-2.18.deref.yaml @@ -25121,7 +25121,9 @@ paths: \ \n\\* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. \n\\* `triage` - Recommended for contributors who need - to proactively manage issues and pull requests without write access." + to proactively manage issues and pull requests without write access. + \n\\* custom repository role name - Can assign a custom repository + role if the owning organization has defined any." enum: - pull - push @@ -38634,9 +38636,6 @@ paths: '410': description: Gone content: *128 - '415': - description: Preview header missing - content: *30 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38648,15 +38647,6 @@ paths: ```shell application/vnd.github.mockingbird-preview ``` - - required: false - name: starfox - note: |- - Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the [blog post](https://developer.github.com/changes/2018-09-05-project-card-events). - - To receive the `project_card` attribute, project boards must be [enabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) for a repository, and you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header: - ```shell - application/vnd.github.starfox-preview+json - ``` category: issues subcategory: timeline "/repos/{owner}/{repo}/keys": diff --git a/descriptions/ghes-2.18/ghes-2.18.json b/descriptions/ghes-2.18/ghes-2.18.json index 0e408d580a..58c3172425 100644 --- a/descriptions/ghes-2.18/ghes-2.18.json +++ b/descriptions/ghes-2.18/ghes-2.18.json @@ -15414,7 +15414,7 @@ "properties": { "permission": { "type": "string", - "description": "The permission to grant the collaborator. **Only valid on organization-owned repositories.** Can be one of: \n\\* `pull` - can pull, but not push to or administer this repository. \n\\* `push` - can pull and push, but not administer this repository. \n\\* `admin` - can pull, push and administer this repository. \n\\* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. \n\\* `triage` - Recommended for contributors who need to proactively manage issues and pull requests without write access.", + "description": "The permission to grant the collaborator. **Only valid on organization-owned repositories.** Can be one of: \n\\* `pull` - can pull, but not push to or administer this repository. \n\\* `push` - can pull and push, but not administer this repository. \n\\* `admin` - can pull, push and administer this repository. \n\\* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. \n\\* `triage` - Recommended for contributors who need to proactively manage issues and pull requests without write access. \n\\* custom repository role name - Can assign a custom repository role if the owning organization has defined any.", "enum": [ "pull", "push", @@ -22537,9 +22537,6 @@ }, "410": { "$ref": "#/components/responses/gone" - }, - "415": { - "$ref": "#/components/responses/preview_header_missing" } }, "x-github": { @@ -22550,11 +22547,6 @@ "required": true, "name": "mockingbird", "note": "The API to get issue timeline events is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-23-timeline-preview-api/) for full details. To access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mockingbird-preview\n```" - }, - { - "required": false, - "name": "starfox", - "note": "Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the [blog post](https://developer.github.com/changes/2018-09-05-project-card-events).\n\nTo receive the `project_card` attribute, project boards must be [enabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) for a repository, and you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.starfox-preview+json\n```" } ], "category": "issues", diff --git a/descriptions/ghes-2.18/ghes-2.18.yaml b/descriptions/ghes-2.18/ghes-2.18.yaml index f9ccd62547..2b0efc8981 100644 --- a/descriptions/ghes-2.18/ghes-2.18.yaml +++ b/descriptions/ghes-2.18/ghes-2.18.yaml @@ -11121,7 +11121,9 @@ paths: \ \n\\* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. \n\\* `triage` - Recommended for contributors who need - to proactively manage issues and pull requests without write access." + to proactively manage issues and pull requests without write access. + \n\\* custom repository role name - Can assign a custom repository + role if the owning organization has defined any." enum: - pull - push @@ -16385,8 +16387,6 @@ paths: "$ref": "#/components/responses/not_found" '410': "$ref": "#/components/responses/gone" - '415': - "$ref": "#/components/responses/preview_header_missing" x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -16398,15 +16398,6 @@ paths: ```shell application/vnd.github.mockingbird-preview ``` - - required: false - name: starfox - note: |- - Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the [blog post](https://developer.github.com/changes/2018-09-05-project-card-events). - - To receive the `project_card` attribute, project boards must be [enabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) for a repository, and you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header: - ```shell - application/vnd.github.starfox-preview+json - ``` category: issues subcategory: timeline "/repos/{owner}/{repo}/keys": diff --git a/descriptions/ghes-2.19/dereferenced/ghes-2.19.deref.json b/descriptions/ghes-2.19/dereferenced/ghes-2.19.deref.json index c469692376..c5da587fbe 100644 --- a/descriptions/ghes-2.19/dereferenced/ghes-2.19.deref.json +++ b/descriptions/ghes-2.19/dereferenced/ghes-2.19.deref.json @@ -105664,7 +105664,7 @@ "properties": { "permission": { "type": "string", - "description": "The permission to grant the collaborator. **Only valid on organization-owned repositories.** Can be one of: \n\\* `pull` - can pull, but not push to or administer this repository. \n\\* `push` - can pull and push, but not administer this repository. \n\\* `admin` - can pull, push and administer this repository. \n\\* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. \n\\* `triage` - Recommended for contributors who need to proactively manage issues and pull requests without write access.", + "description": "The permission to grant the collaborator. **Only valid on organization-owned repositories.** Can be one of: \n\\* `pull` - can pull, but not push to or administer this repository. \n\\* `push` - can pull and push, but not administer this repository. \n\\* `admin` - can pull, push and administer this repository. \n\\* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. \n\\* `triage` - Recommended for contributors who need to proactively manage issues and pull requests without write access. \n\\* custom repository role name - Can assign a custom repository role if the owning organization has defined any.", "enum": [ "pull", "push", @@ -199578,28 +199578,6 @@ } } } - }, - "415": { - "description": "Preview header missing", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } } }, "x-github": { @@ -199610,11 +199588,6 @@ "required": true, "name": "mockingbird", "note": "The API to get issue timeline events is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-23-timeline-preview-api/) for full details. To access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mockingbird-preview\n```" - }, - { - "required": false, - "name": "starfox", - "note": "Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the [blog post](https://developer.github.com/changes/2018-09-05-project-card-events).\n\nTo receive the `project_card` attribute, project boards must be [enabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) for a repository, and you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.starfox-preview+json\n```" } ], "category": "issues", diff --git a/descriptions/ghes-2.19/dereferenced/ghes-2.19.deref.yaml b/descriptions/ghes-2.19/dereferenced/ghes-2.19.deref.yaml index b540a9e37a..13dea0bf61 100644 --- a/descriptions/ghes-2.19/dereferenced/ghes-2.19.deref.yaml +++ b/descriptions/ghes-2.19/dereferenced/ghes-2.19.deref.yaml @@ -25712,7 +25712,9 @@ paths: \ \n\\* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. \n\\* `triage` - Recommended for contributors who need - to proactively manage issues and pull requests without write access." + to proactively manage issues and pull requests without write access. + \n\\* custom repository role name - Can assign a custom repository + role if the owning organization has defined any." enum: - pull - push @@ -39300,9 +39302,6 @@ paths: '410': description: Gone content: *127 - '415': - description: Preview header missing - content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -39314,15 +39313,6 @@ paths: ```shell application/vnd.github.mockingbird-preview ``` - - required: false - name: starfox - note: |- - Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the [blog post](https://developer.github.com/changes/2018-09-05-project-card-events). - - To receive the `project_card` attribute, project boards must be [enabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) for a repository, and you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header: - ```shell - application/vnd.github.starfox-preview+json - ``` category: issues subcategory: timeline "/repos/{owner}/{repo}/keys": diff --git a/descriptions/ghes-2.19/ghes-2.19.json b/descriptions/ghes-2.19/ghes-2.19.json index 94a907998c..ab131bfcb6 100644 --- a/descriptions/ghes-2.19/ghes-2.19.json +++ b/descriptions/ghes-2.19/ghes-2.19.json @@ -15824,7 +15824,7 @@ "properties": { "permission": { "type": "string", - "description": "The permission to grant the collaborator. **Only valid on organization-owned repositories.** Can be one of: \n\\* `pull` - can pull, but not push to or administer this repository. \n\\* `push` - can pull and push, but not administer this repository. \n\\* `admin` - can pull, push and administer this repository. \n\\* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. \n\\* `triage` - Recommended for contributors who need to proactively manage issues and pull requests without write access.", + "description": "The permission to grant the collaborator. **Only valid on organization-owned repositories.** Can be one of: \n\\* `pull` - can pull, but not push to or administer this repository. \n\\* `push` - can pull and push, but not administer this repository. \n\\* `admin` - can pull, push and administer this repository. \n\\* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. \n\\* `triage` - Recommended for contributors who need to proactively manage issues and pull requests without write access. \n\\* custom repository role name - Can assign a custom repository role if the owning organization has defined any.", "enum": [ "pull", "push", @@ -23028,9 +23028,6 @@ }, "410": { "$ref": "#/components/responses/gone" - }, - "415": { - "$ref": "#/components/responses/preview_header_missing" } }, "x-github": { @@ -23041,11 +23038,6 @@ "required": true, "name": "mockingbird", "note": "The API to get issue timeline events is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-23-timeline-preview-api/) for full details. To access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mockingbird-preview\n```" - }, - { - "required": false, - "name": "starfox", - "note": "Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the [blog post](https://developer.github.com/changes/2018-09-05-project-card-events).\n\nTo receive the `project_card` attribute, project boards must be [enabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) for a repository, and you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.starfox-preview+json\n```" } ], "category": "issues", diff --git a/descriptions/ghes-2.19/ghes-2.19.yaml b/descriptions/ghes-2.19/ghes-2.19.yaml index a0a36418aa..97090b2649 100644 --- a/descriptions/ghes-2.19/ghes-2.19.yaml +++ b/descriptions/ghes-2.19/ghes-2.19.yaml @@ -11389,7 +11389,9 @@ paths: \ \n\\* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. \n\\* `triage` - Recommended for contributors who need - to proactively manage issues and pull requests without write access." + to proactively manage issues and pull requests without write access. + \n\\* custom repository role name - Can assign a custom repository + role if the owning organization has defined any." enum: - pull - push @@ -16701,8 +16703,6 @@ paths: "$ref": "#/components/responses/not_found" '410': "$ref": "#/components/responses/gone" - '415': - "$ref": "#/components/responses/preview_header_missing" x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -16714,15 +16714,6 @@ paths: ```shell application/vnd.github.mockingbird-preview ``` - - required: false - name: starfox - note: |- - Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the [blog post](https://developer.github.com/changes/2018-09-05-project-card-events). - - To receive the `project_card` attribute, project boards must be [enabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) for a repository, and you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header: - ```shell - application/vnd.github.starfox-preview+json - ``` category: issues subcategory: timeline "/repos/{owner}/{repo}/keys": diff --git a/descriptions/ghes-2.20/dereferenced/ghes-2.20.deref.json b/descriptions/ghes-2.20/dereferenced/ghes-2.20.deref.json index 9b9e6ca4cb..bdb4515592 100644 --- a/descriptions/ghes-2.20/dereferenced/ghes-2.20.deref.json +++ b/descriptions/ghes-2.20/dereferenced/ghes-2.20.deref.json @@ -107877,7 +107877,7 @@ "properties": { "permission": { "type": "string", - "description": "The permission to grant the collaborator. **Only valid on organization-owned repositories.** Can be one of: \n\\* `pull` - can pull, but not push to or administer this repository. \n\\* `push` - can pull and push, but not administer this repository. \n\\* `admin` - can pull, push and administer this repository. \n\\* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. \n\\* `triage` - Recommended for contributors who need to proactively manage issues and pull requests without write access.", + "description": "The permission to grant the collaborator. **Only valid on organization-owned repositories.** Can be one of: \n\\* `pull` - can pull, but not push to or administer this repository. \n\\* `push` - can pull and push, but not administer this repository. \n\\* `admin` - can pull, push and administer this repository. \n\\* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. \n\\* `triage` - Recommended for contributors who need to proactively manage issues and pull requests without write access. \n\\* custom repository role name - Can assign a custom repository role if the owning organization has defined any.", "enum": [ "pull", "push", @@ -202026,28 +202026,6 @@ } } } - }, - "415": { - "description": "Preview header missing", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } } }, "x-github": { @@ -202058,11 +202036,6 @@ "required": true, "name": "mockingbird", "note": "The API to get issue timeline events is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-23-timeline-preview-api/) for full details. To access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mockingbird-preview\n```" - }, - { - "required": false, - "name": "starfox", - "note": "Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the [blog post](https://developer.github.com/changes/2018-09-05-project-card-events).\n\nTo receive the `project_card` attribute, project boards must be [enabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) for a repository, and you must provide a custom [media type](https://docs.github.com/enterprise-server@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.starfox-preview+json\n```" } ], "category": "issues", diff --git a/descriptions/ghes-2.20/dereferenced/ghes-2.20.deref.yaml b/descriptions/ghes-2.20/dereferenced/ghes-2.20.deref.yaml index 13a4a057b2..97a244e6d5 100644 --- a/descriptions/ghes-2.20/dereferenced/ghes-2.20.deref.yaml +++ b/descriptions/ghes-2.20/dereferenced/ghes-2.20.deref.yaml @@ -25791,7 +25791,9 @@ paths: \ \n\\* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. \n\\* `triage` - Recommended for contributors who need - to proactively manage issues and pull requests without write access." + to proactively manage issues and pull requests without write access. + \n\\* custom repository role name - Can assign a custom repository + role if the owning organization has defined any." enum: - pull - push @@ -39425,9 +39427,6 @@ paths: '410': description: Gone content: *126 - '415': - description: Preview header missing - content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -39439,15 +39438,6 @@ paths: ```shell application/vnd.github.mockingbird-preview ``` - - required: false - name: starfox - note: |- - Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the [blog post](https://developer.github.com/changes/2018-09-05-project-card-events). - - To receive the `project_card` attribute, project boards must be [enabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) for a repository, and you must provide a custom [media type](https://docs.github.com/enterprise-server@2.20/rest/overview/media-types) in the `Accept` header: - ```shell - application/vnd.github.starfox-preview+json - ``` category: issues subcategory: timeline "/repos/{owner}/{repo}/keys": diff --git a/descriptions/ghes-2.20/ghes-2.20.json b/descriptions/ghes-2.20/ghes-2.20.json index 4bbf9f07a1..9f54e6d0c8 100644 --- a/descriptions/ghes-2.20/ghes-2.20.json +++ b/descriptions/ghes-2.20/ghes-2.20.json @@ -16111,7 +16111,7 @@ "properties": { "permission": { "type": "string", - "description": "The permission to grant the collaborator. **Only valid on organization-owned repositories.** Can be one of: \n\\* `pull` - can pull, but not push to or administer this repository. \n\\* `push` - can pull and push, but not administer this repository. \n\\* `admin` - can pull, push and administer this repository. \n\\* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. \n\\* `triage` - Recommended for contributors who need to proactively manage issues and pull requests without write access.", + "description": "The permission to grant the collaborator. **Only valid on organization-owned repositories.** Can be one of: \n\\* `pull` - can pull, but not push to or administer this repository. \n\\* `push` - can pull and push, but not administer this repository. \n\\* `admin` - can pull, push and administer this repository. \n\\* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. \n\\* `triage` - Recommended for contributors who need to proactively manage issues and pull requests without write access. \n\\* custom repository role name - Can assign a custom repository role if the owning organization has defined any.", "enum": [ "pull", "push", @@ -23315,9 +23315,6 @@ }, "410": { "$ref": "#/components/responses/gone" - }, - "415": { - "$ref": "#/components/responses/preview_header_missing" } }, "x-github": { @@ -23328,11 +23325,6 @@ "required": true, "name": "mockingbird", "note": "The API to get issue timeline events is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-23-timeline-preview-api/) for full details. To access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mockingbird-preview\n```" - }, - { - "required": false, - "name": "starfox", - "note": "Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the [blog post](https://developer.github.com/changes/2018-09-05-project-card-events).\n\nTo receive the `project_card` attribute, project boards must be [enabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) for a repository, and you must provide a custom [media type](https://docs.github.com/enterprise-server@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.starfox-preview+json\n```" } ], "category": "issues", diff --git a/descriptions/ghes-2.20/ghes-2.20.yaml b/descriptions/ghes-2.20/ghes-2.20.yaml index ffff8d5564..a0fd2a5174 100644 --- a/descriptions/ghes-2.20/ghes-2.20.yaml +++ b/descriptions/ghes-2.20/ghes-2.20.yaml @@ -11591,7 +11591,9 @@ paths: \ \n\\* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. \n\\* `triage` - Recommended for contributors who need - to proactively manage issues and pull requests without write access." + to proactively manage issues and pull requests without write access. + \n\\* custom repository role name - Can assign a custom repository + role if the owning organization has defined any." enum: - pull - push @@ -16903,8 +16905,6 @@ paths: "$ref": "#/components/responses/not_found" '410': "$ref": "#/components/responses/gone" - '415': - "$ref": "#/components/responses/preview_header_missing" x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -16916,15 +16916,6 @@ paths: ```shell application/vnd.github.mockingbird-preview ``` - - required: false - name: starfox - note: |- - Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the [blog post](https://developer.github.com/changes/2018-09-05-project-card-events). - - To receive the `project_card` attribute, project boards must be [enabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) for a repository, and you must provide a custom [media type](https://docs.github.com/enterprise-server@2.20/rest/overview/media-types) in the `Accept` header: - ```shell - application/vnd.github.starfox-preview+json - ``` category: issues subcategory: timeline "/repos/{owner}/{repo}/keys": diff --git a/descriptions/ghes-2.21/dereferenced/ghes-2.21.deref.json b/descriptions/ghes-2.21/dereferenced/ghes-2.21.deref.json index f283729dd8..06d2445a5a 100644 --- a/descriptions/ghes-2.21/dereferenced/ghes-2.21.deref.json +++ b/descriptions/ghes-2.21/dereferenced/ghes-2.21.deref.json @@ -119623,7 +119623,7 @@ "properties": { "permission": { "type": "string", - "description": "The permission to grant the collaborator. **Only valid on organization-owned repositories.** Can be one of: \n\\* `pull` - can pull, but not push to or administer this repository. \n\\* `push` - can pull and push, but not administer this repository. \n\\* `admin` - can pull, push and administer this repository. \n\\* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. \n\\* `triage` - Recommended for contributors who need to proactively manage issues and pull requests without write access.", + "description": "The permission to grant the collaborator. **Only valid on organization-owned repositories.** Can be one of: \n\\* `pull` - can pull, but not push to or administer this repository. \n\\* `push` - can pull and push, but not administer this repository. \n\\* `admin` - can pull, push and administer this repository. \n\\* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. \n\\* `triage` - Recommended for contributors who need to proactively manage issues and pull requests without write access. \n\\* custom repository role name - Can assign a custom repository role if the owning organization has defined any.", "enum": [ "pull", "push", @@ -214453,28 +214453,6 @@ } } } - }, - "415": { - "description": "Preview header missing", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } } }, "x-github": { @@ -214485,11 +214463,6 @@ "required": true, "name": "mockingbird", "note": "The API to get issue timeline events is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-23-timeline-preview-api/) for full details. To access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mockingbird-preview\n```" - }, - { - "required": false, - "name": "starfox", - "note": "Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the [blog post](https://developer.github.com/changes/2018-09-05-project-card-events).\n\nTo receive the `project_card` attribute, project boards must be [enabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) for a repository, and you must provide a custom [media type](https://docs.github.com/enterprise-server@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.starfox-preview+json\n```" } ], "category": "issues", diff --git a/descriptions/ghes-2.21/dereferenced/ghes-2.21.deref.yaml b/descriptions/ghes-2.21/dereferenced/ghes-2.21.deref.yaml index 6932abc52d..b3c02e2e54 100644 --- a/descriptions/ghes-2.21/dereferenced/ghes-2.21.deref.yaml +++ b/descriptions/ghes-2.21/dereferenced/ghes-2.21.deref.yaml @@ -29177,7 +29177,9 @@ paths: \ \n\\* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. \n\\* `triage` - Recommended for contributors who need - to proactively manage issues and pull requests without write access." + to proactively manage issues and pull requests without write access. + \n\\* custom repository role name - Can assign a custom repository + role if the owning organization has defined any." enum: - pull - push @@ -42996,9 +42998,6 @@ paths: '410': description: Gone content: *126 - '415': - description: Preview header missing - content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43010,15 +43009,6 @@ paths: ```shell application/vnd.github.mockingbird-preview ``` - - required: false - name: starfox - note: |- - Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the [blog post](https://developer.github.com/changes/2018-09-05-project-card-events). - - To receive the `project_card` attribute, project boards must be [enabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) for a repository, and you must provide a custom [media type](https://docs.github.com/enterprise-server@2.21/rest/overview/media-types) in the `Accept` header: - ```shell - application/vnd.github.starfox-preview+json - ``` category: issues subcategory: timeline "/repos/{owner}/{repo}/keys": diff --git a/descriptions/ghes-2.21/ghes-2.21.json b/descriptions/ghes-2.21/ghes-2.21.json index 0ac32b3e45..31a8bff698 100644 --- a/descriptions/ghes-2.21/ghes-2.21.json +++ b/descriptions/ghes-2.21/ghes-2.21.json @@ -18154,7 +18154,7 @@ "properties": { "permission": { "type": "string", - "description": "The permission to grant the collaborator. **Only valid on organization-owned repositories.** Can be one of: \n\\* `pull` - can pull, but not push to or administer this repository. \n\\* `push` - can pull and push, but not administer this repository. \n\\* `admin` - can pull, push and administer this repository. \n\\* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. \n\\* `triage` - Recommended for contributors who need to proactively manage issues and pull requests without write access.", + "description": "The permission to grant the collaborator. **Only valid on organization-owned repositories.** Can be one of: \n\\* `pull` - can pull, but not push to or administer this repository. \n\\* `push` - can pull and push, but not administer this repository. \n\\* `admin` - can pull, push and administer this repository. \n\\* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. \n\\* `triage` - Recommended for contributors who need to proactively manage issues and pull requests without write access. \n\\* custom repository role name - Can assign a custom repository role if the owning organization has defined any.", "enum": [ "pull", "push", @@ -25612,9 +25612,6 @@ }, "410": { "$ref": "#/components/responses/gone" - }, - "415": { - "$ref": "#/components/responses/preview_header_missing" } }, "x-github": { @@ -25625,11 +25622,6 @@ "required": true, "name": "mockingbird", "note": "The API to get issue timeline events is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-23-timeline-preview-api/) for full details. To access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mockingbird-preview\n```" - }, - { - "required": false, - "name": "starfox", - "note": "Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the [blog post](https://developer.github.com/changes/2018-09-05-project-card-events).\n\nTo receive the `project_card` attribute, project boards must be [enabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) for a repository, and you must provide a custom [media type](https://docs.github.com/enterprise-server@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.starfox-preview+json\n```" } ], "category": "issues", diff --git a/descriptions/ghes-2.21/ghes-2.21.yaml b/descriptions/ghes-2.21/ghes-2.21.yaml index a0e872a17e..175e179cd8 100644 --- a/descriptions/ghes-2.21/ghes-2.21.yaml +++ b/descriptions/ghes-2.21/ghes-2.21.yaml @@ -13118,7 +13118,9 @@ paths: \ \n\\* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. \n\\* `triage` - Recommended for contributors who need - to proactively manage issues and pull requests without write access." + to proactively manage issues and pull requests without write access. + \n\\* custom repository role name - Can assign a custom repository + role if the owning organization has defined any." enum: - pull - push @@ -18634,8 +18636,6 @@ paths: "$ref": "#/components/responses/not_found" '410': "$ref": "#/components/responses/gone" - '415': - "$ref": "#/components/responses/preview_header_missing" x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18647,15 +18647,6 @@ paths: ```shell application/vnd.github.mockingbird-preview ``` - - required: false - name: starfox - note: |- - Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the [blog post](https://developer.github.com/changes/2018-09-05-project-card-events). - - To receive the `project_card` attribute, project boards must be [enabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) for a repository, and you must provide a custom [media type](https://docs.github.com/enterprise-server@2.21/rest/overview/media-types) in the `Accept` header: - ```shell - application/vnd.github.starfox-preview+json - ``` category: issues subcategory: timeline "/repos/{owner}/{repo}/keys": diff --git a/descriptions/ghes-2.22/dereferenced/ghes-2.22.deref.json b/descriptions/ghes-2.22/dereferenced/ghes-2.22.deref.json index 7d59aa25a2..05af09852f 100644 --- a/descriptions/ghes-2.22/dereferenced/ghes-2.22.deref.json +++ b/descriptions/ghes-2.22/dereferenced/ghes-2.22.deref.json @@ -108750,6 +108750,11 @@ "description": "The auto incrementing run number for the workflow run.", "example": 106 }, + "run_attempt": { + "type": "integer", + "description": "Attempt number of the run, 1 for first attempt and higher if the workflow was retried.", + "example": 1 + }, "event": { "type": "string", "example": "push" @@ -108912,6 +108917,12 @@ "type": "string", "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/rerun" }, + "previous_attempt_url": { + "nullable": true, + "description": "The URL to the previous attempted run of this workflow, if one exists.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3" + }, "workflow_url": { "description": "The URL to the workflow.", "type": "string", @@ -112620,6 +112631,11 @@ "description": "The auto incrementing run number for the workflow run.", "example": 106 }, + "run_attempt": { + "type": "integer", + "description": "Attempt number of the run, 1 for first attempt and higher if the workflow was retried.", + "example": 1 + }, "event": { "type": "string", "example": "push" @@ -112782,6 +112798,12 @@ "type": "string", "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/rerun" }, + "previous_attempt_url": { + "nullable": true, + "description": "The URL to the previous attempted run of this workflow, if one exists.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3" + }, "workflow_url": { "description": "The URL to the workflow.", "type": "string", @@ -117244,9 +117266,11 @@ "previews": [ ], + "deprecationDate": "2021-09-14", "category": "actions", "subcategory": "workflow-runs" - } + }, + "deprecated": true } }, "/repos/{owner}/{repo}/actions/secrets": { @@ -118350,6 +118374,11 @@ "description": "The auto incrementing run number for the workflow run.", "example": 106 }, + "run_attempt": { + "type": "integer", + "description": "Attempt number of the run, 1 for first attempt and higher if the workflow was retried.", + "example": 1 + }, "event": { "type": "string", "example": "push" @@ -118512,6 +118541,12 @@ "type": "string", "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/rerun" }, + "previous_attempt_url": { + "nullable": true, + "description": "The URL to the previous attempted run of this workflow, if one exists.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3" + }, "workflow_url": { "description": "The URL to the workflow.", "type": "string", @@ -151372,7 +151407,7 @@ "properties": { "permission": { "type": "string", - "description": "The permission to grant the collaborator. **Only valid on organization-owned repositories.** Can be one of: \n\\* `pull` - can pull, but not push to or administer this repository. \n\\* `push` - can pull and push, but not administer this repository. \n\\* `admin` - can pull, push and administer this repository. \n\\* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. \n\\* `triage` - Recommended for contributors who need to proactively manage issues and pull requests without write access.", + "description": "The permission to grant the collaborator. **Only valid on organization-owned repositories.** Can be one of: \n\\* `pull` - can pull, but not push to or administer this repository. \n\\* `push` - can pull and push, but not administer this repository. \n\\* `admin` - can pull, push and administer this repository. \n\\* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. \n\\* `triage` - Recommended for contributors who need to proactively manage issues and pull requests without write access. \n\\* custom repository role name - Can assign a custom repository role if the owning organization has defined any.", "enum": [ "pull", "push", @@ -246201,28 +246236,6 @@ } } } - }, - "415": { - "description": "Preview header missing", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } } }, "x-github": { @@ -246233,11 +246246,6 @@ "required": true, "name": "mockingbird", "note": "The API to get issue timeline events is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-23-timeline-preview-api/) for full details. To access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mockingbird-preview\n```" - }, - { - "required": false, - "name": "starfox", - "note": "Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the [blog post](https://developer.github.com/changes/2018-09-05-project-card-events).\n\nTo receive the `project_card` attribute, project boards must be [enabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) for a repository, and you must provide a custom [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.starfox-preview+json\n```" } ], "category": "issues", diff --git a/descriptions/ghes-2.22/dereferenced/ghes-2.22.deref.yaml b/descriptions/ghes-2.22/dereferenced/ghes-2.22.deref.yaml index b39bd3bfbb..b66c950ba2 100644 --- a/descriptions/ghes-2.22/dereferenced/ghes-2.22.deref.yaml +++ b/descriptions/ghes-2.22/dereferenced/ghes-2.22.deref.yaml @@ -27043,6 +27043,11 @@ paths: description: The auto incrementing run number for the workflow run. example: 106 + run_attempt: + type: integer + description: Attempt number of the run, 1 for first attempt + and higher if the workflow was retried. + example: 1 event: type: string example: push @@ -27163,6 +27168,12 @@ paths: description: The URL to rerun the workflow run. type: string example: https://api.github.com/repos/github/hello-world/actions/runs/5/rerun + previous_attempt_url: + nullable: true + description: The URL to the previous attempted run of this + workflow, if one exists. + type: string + example: https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3 workflow_url: description: The URL to the workflow. type: string @@ -28069,8 +28080,10 @@ paths: githubCloudOnly: false enabledForGitHubApps: false previews: [] + deprecationDate: '2021-09-14' category: actions subcategory: workflow-runs + deprecated: true "/repos/{owner}/{repo}/actions/secrets": get: summary: List repository secrets @@ -35864,7 +35877,9 @@ paths: \ \n\\* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. \n\\* `triage` - Recommended for contributors who need - to proactively manage issues and pull requests without write access." + to proactively manage issues and pull requests without write access. + \n\\* custom repository role name - Can assign a custom repository + role if the owning organization has defined any." enum: - pull - push @@ -49663,9 +49678,6 @@ paths: '410': description: Gone content: *153 - '415': - description: Preview header missing - content: *30 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49677,15 +49689,6 @@ paths: ```shell application/vnd.github.mockingbird-preview ``` - - required: false - name: starfox - note: |- - Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the [blog post](https://developer.github.com/changes/2018-09-05-project-card-events). - - To receive the `project_card` attribute, project boards must be [enabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) for a repository, and you must provide a custom [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types) in the `Accept` header: - ```shell - application/vnd.github.starfox-preview+json - ``` category: issues subcategory: timeline "/repos/{owner}/{repo}/keys": diff --git a/descriptions/ghes-2.22/ghes-2.22.json b/descriptions/ghes-2.22/ghes-2.22.json index e73aa5dbdd..175faf819a 100644 --- a/descriptions/ghes-2.22/ghes-2.22.json +++ b/descriptions/ghes-2.22/ghes-2.22.json @@ -17844,9 +17844,11 @@ "previews": [ ], + "deprecationDate": "2021-09-14", "category": "actions", "subcategory": "workflow-runs" - } + }, + "deprecated": true } }, "/repos/{owner}/{repo}/actions/secrets": { @@ -22854,7 +22856,7 @@ "properties": { "permission": { "type": "string", - "description": "The permission to grant the collaborator. **Only valid on organization-owned repositories.** Can be one of: \n\\* `pull` - can pull, but not push to or administer this repository. \n\\* `push` - can pull and push, but not administer this repository. \n\\* `admin` - can pull, push and administer this repository. \n\\* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. \n\\* `triage` - Recommended for contributors who need to proactively manage issues and pull requests without write access.", + "description": "The permission to grant the collaborator. **Only valid on organization-owned repositories.** Can be one of: \n\\* `pull` - can pull, but not push to or administer this repository. \n\\* `push` - can pull and push, but not administer this repository. \n\\* `admin` - can pull, push and administer this repository. \n\\* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. \n\\* `triage` - Recommended for contributors who need to proactively manage issues and pull requests without write access. \n\\* custom repository role name - Can assign a custom repository role if the owning organization has defined any.", "enum": [ "pull", "push", @@ -30267,9 +30269,6 @@ }, "410": { "$ref": "#/components/responses/gone" - }, - "415": { - "$ref": "#/components/responses/preview_header_missing" } }, "x-github": { @@ -30280,11 +30279,6 @@ "required": true, "name": "mockingbird", "note": "The API to get issue timeline events is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-23-timeline-preview-api/) for full details. To access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mockingbird-preview\n```" - }, - { - "required": false, - "name": "starfox", - "note": "Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the [blog post](https://developer.github.com/changes/2018-09-05-project-card-events).\n\nTo receive the `project_card` attribute, project boards must be [enabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) for a repository, and you must provide a custom [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.starfox-preview+json\n```" } ], "category": "issues", @@ -55391,6 +55385,11 @@ "description": "The auto incrementing run number for the workflow run.", "example": 106 }, + "run_attempt": { + "type": "integer", + "description": "Attempt number of the run, 1 for first attempt and higher if the workflow was retried.", + "example": 1 + }, "event": { "type": "string", "example": "push" @@ -55464,6 +55463,12 @@ "type": "string", "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/rerun" }, + "previous_attempt_url": { + "nullable": true, + "description": "The URL to the previous attempted run of this workflow, if one exists.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3" + }, "workflow_url": { "description": "The URL to the workflow.", "type": "string", diff --git a/descriptions/ghes-2.22/ghes-2.22.yaml b/descriptions/ghes-2.22/ghes-2.22.yaml index af7af5d1cb..da95c10fb6 100644 --- a/descriptions/ghes-2.22/ghes-2.22.yaml +++ b/descriptions/ghes-2.22/ghes-2.22.yaml @@ -12762,8 +12762,10 @@ paths: githubCloudOnly: false enabledForGitHubApps: false previews: [] + deprecationDate: '2021-09-14' category: actions subcategory: workflow-runs + deprecated: true "/repos/{owner}/{repo}/actions/secrets": get: summary: List repository secrets @@ -16466,7 +16468,9 @@ paths: \ \n\\* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. \n\\* `triage` - Recommended for contributors who need - to proactively manage issues and pull requests without write access." + to proactively manage issues and pull requests without write access. + \n\\* custom repository role name - Can assign a custom repository + role if the owning organization has defined any." enum: - pull - push @@ -21924,8 +21928,6 @@ paths: "$ref": "#/components/responses/not_found" '410': "$ref": "#/components/responses/gone" - '415': - "$ref": "#/components/responses/preview_header_missing" x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21937,15 +21939,6 @@ paths: ```shell application/vnd.github.mockingbird-preview ``` - - required: false - name: starfox - note: |- - Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the [blog post](https://developer.github.com/changes/2018-09-05-project-card-events). - - To receive the `project_card` attribute, project boards must be [enabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) for a repository, and you must provide a custom [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types) in the `Accept` header: - ```shell - application/vnd.github.starfox-preview+json - ``` category: issues subcategory: timeline "/repos/{owner}/{repo}/keys": @@ -40463,6 +40456,11 @@ components: type: integer description: The auto incrementing run number for the workflow run. example: 106 + run_attempt: + type: integer + description: Attempt number of the run, 1 for first attempt and higher if + the workflow was retried. + example: 1 event: type: string example: push @@ -40520,6 +40518,12 @@ components: description: The URL to rerun the workflow run. type: string example: https://api.github.com/repos/github/hello-world/actions/runs/5/rerun + previous_attempt_url: + nullable: true + description: The URL to the previous attempted run of this workflow, if + one exists. + type: string + example: https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3 workflow_url: description: The URL to the workflow. type: string diff --git a/descriptions/ghes-3.0/dereferenced/ghes-3.0.deref.json b/descriptions/ghes-3.0/dereferenced/ghes-3.0.deref.json index 8f411867dd..4639280579 100644 --- a/descriptions/ghes-3.0/dereferenced/ghes-3.0.deref.json +++ b/descriptions/ghes-3.0/dereferenced/ghes-3.0.deref.json @@ -114875,6 +114875,11 @@ "description": "The auto incrementing run number for the workflow run.", "example": 106 }, + "run_attempt": { + "type": "integer", + "description": "Attempt number of the run, 1 for first attempt and higher if the workflow was retried.", + "example": 1 + }, "event": { "type": "string", "example": "push" @@ -115037,6 +115042,12 @@ "type": "string", "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/rerun" }, + "previous_attempt_url": { + "nullable": true, + "description": "The URL to the previous attempted run of this workflow, if one exists.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3" + }, "workflow_url": { "description": "The URL to the workflow.", "type": "string", @@ -118745,6 +118756,11 @@ "description": "The auto incrementing run number for the workflow run.", "example": 106 }, + "run_attempt": { + "type": "integer", + "description": "Attempt number of the run, 1 for first attempt and higher if the workflow was retried.", + "example": 1 + }, "event": { "type": "string", "example": "push" @@ -118907,6 +118923,12 @@ "type": "string", "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/rerun" }, + "previous_attempt_url": { + "nullable": true, + "description": "The URL to the previous attempted run of this workflow, if one exists.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3" + }, "workflow_url": { "description": "The URL to the workflow.", "type": "string", @@ -123369,9 +123391,11 @@ "previews": [ ], + "deprecationDate": "2021-09-14", "category": "actions", "subcategory": "workflow-runs" - } + }, + "deprecated": true } }, "/repos/{owner}/{repo}/actions/secrets": { @@ -124599,6 +124623,11 @@ "description": "The auto incrementing run number for the workflow run.", "example": 106 }, + "run_attempt": { + "type": "integer", + "description": "Attempt number of the run, 1 for first attempt and higher if the workflow was retried.", + "example": 1 + }, "event": { "type": "string", "example": "push" @@ -124761,6 +124790,12 @@ "type": "string", "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/rerun" }, + "previous_attempt_url": { + "nullable": true, + "description": "The URL to the previous attempted run of this workflow, if one exists.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3" + }, "workflow_url": { "description": "The URL to the workflow.", "type": "string", @@ -157714,7 +157749,7 @@ "properties": { "permission": { "type": "string", - "description": "The permission to grant the collaborator. **Only valid on organization-owned repositories.** Can be one of: \n\\* `pull` - can pull, but not push to or administer this repository. \n\\* `push` - can pull and push, but not administer this repository. \n\\* `admin` - can pull, push and administer this repository. \n\\* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. \n\\* `triage` - Recommended for contributors who need to proactively manage issues and pull requests without write access.", + "description": "The permission to grant the collaborator. **Only valid on organization-owned repositories.** Can be one of: \n\\* `pull` - can pull, but not push to or administer this repository. \n\\* `push` - can pull and push, but not administer this repository. \n\\* `admin` - can pull, push and administer this repository. \n\\* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. \n\\* `triage` - Recommended for contributors who need to proactively manage issues and pull requests without write access. \n\\* custom repository role name - Can assign a custom repository role if the owning organization has defined any.", "enum": [ "pull", "push", @@ -253033,28 +253068,6 @@ } } } - }, - "415": { - "description": "Preview header missing", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } } }, "x-github": { @@ -253065,11 +253078,6 @@ "required": true, "name": "mockingbird", "note": "The API to get issue timeline events is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-23-timeline-preview-api/) for full details. To access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mockingbird-preview\n```" - }, - { - "required": false, - "name": "starfox", - "note": "Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the [blog post](https://developer.github.com/changes/2018-09-05-project-card-events).\n\nTo receive the `project_card` attribute, project boards must be [enabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) for a repository, and you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.starfox-preview+json\n```" } ], "category": "issues", diff --git a/descriptions/ghes-3.0/dereferenced/ghes-3.0.deref.yaml b/descriptions/ghes-3.0/dereferenced/ghes-3.0.deref.yaml index 5c1886fe26..f628aed1c2 100644 --- a/descriptions/ghes-3.0/dereferenced/ghes-3.0.deref.yaml +++ b/descriptions/ghes-3.0/dereferenced/ghes-3.0.deref.yaml @@ -28705,6 +28705,11 @@ paths: description: The auto incrementing run number for the workflow run. example: 106 + run_attempt: + type: integer + description: Attempt number of the run, 1 for first attempt + and higher if the workflow was retried. + example: 1 event: type: string example: push @@ -28825,6 +28830,12 @@ paths: description: The URL to rerun the workflow run. type: string example: https://api.github.com/repos/github/hello-world/actions/runs/5/rerun + previous_attempt_url: + nullable: true + description: The URL to the previous attempted run of this + workflow, if one exists. + type: string + example: https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3 workflow_url: description: The URL to the workflow. type: string @@ -29731,8 +29742,10 @@ paths: githubCloudOnly: false enabledForGitHubApps: false previews: [] + deprecationDate: '2021-09-14' category: actions subcategory: workflow-runs + deprecated: true "/repos/{owner}/{repo}/actions/secrets": get: summary: List repository secrets @@ -37543,7 +37556,9 @@ paths: \ \n\\* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. \n\\* `triage` - Recommended for contributors who need - to proactively manage issues and pull requests without write access." + to proactively manage issues and pull requests without write access. + \n\\* custom repository role name - Can assign a custom repository + role if the owning organization has defined any." enum: - pull - push @@ -51447,9 +51462,6 @@ paths: '410': description: Gone content: *166 - '415': - description: Preview header missing - content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51461,15 +51473,6 @@ paths: ```shell application/vnd.github.mockingbird-preview ``` - - required: false - name: starfox - note: |- - Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the [blog post](https://developer.github.com/changes/2018-09-05-project-card-events). - - To receive the `project_card` attribute, project boards must be [enabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) for a repository, and you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header: - ```shell - application/vnd.github.starfox-preview+json - ``` category: issues subcategory: timeline "/repos/{owner}/{repo}/keys": diff --git a/descriptions/ghes-3.0/ghes-3.0.json b/descriptions/ghes-3.0/ghes-3.0.json index f374defe17..e42bf4937d 100644 --- a/descriptions/ghes-3.0/ghes-3.0.json +++ b/descriptions/ghes-3.0/ghes-3.0.json @@ -19266,9 +19266,11 @@ "previews": [ ], + "deprecationDate": "2021-09-14", "category": "actions", "subcategory": "workflow-runs" - } + }, + "deprecated": true } }, "/repos/{owner}/{repo}/actions/secrets": { @@ -24318,7 +24320,7 @@ "properties": { "permission": { "type": "string", - "description": "The permission to grant the collaborator. **Only valid on organization-owned repositories.** Can be one of: \n\\* `pull` - can pull, but not push to or administer this repository. \n\\* `push` - can pull and push, but not administer this repository. \n\\* `admin` - can pull, push and administer this repository. \n\\* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. \n\\* `triage` - Recommended for contributors who need to proactively manage issues and pull requests without write access.", + "description": "The permission to grant the collaborator. **Only valid on organization-owned repositories.** Can be one of: \n\\* `pull` - can pull, but not push to or administer this repository. \n\\* `push` - can pull and push, but not administer this repository. \n\\* `admin` - can pull, push and administer this repository. \n\\* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. \n\\* `triage` - Recommended for contributors who need to proactively manage issues and pull requests without write access. \n\\* custom repository role name - Can assign a custom repository role if the owning organization has defined any.", "enum": [ "pull", "push", @@ -31853,9 +31855,6 @@ }, "410": { "$ref": "#/components/responses/gone" - }, - "415": { - "$ref": "#/components/responses/preview_header_missing" } }, "x-github": { @@ -31866,11 +31865,6 @@ "required": true, "name": "mockingbird", "note": "The API to get issue timeline events is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-23-timeline-preview-api/) for full details. To access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mockingbird-preview\n```" - }, - { - "required": false, - "name": "starfox", - "note": "Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the [blog post](https://developer.github.com/changes/2018-09-05-project-card-events).\n\nTo receive the `project_card` attribute, project boards must be [enabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) for a repository, and you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.starfox-preview+json\n```" } ], "category": "issues", @@ -57164,6 +57158,11 @@ "description": "The auto incrementing run number for the workflow run.", "example": 106 }, + "run_attempt": { + "type": "integer", + "description": "Attempt number of the run, 1 for first attempt and higher if the workflow was retried.", + "example": 1 + }, "event": { "type": "string", "example": "push" @@ -57237,6 +57236,12 @@ "type": "string", "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/rerun" }, + "previous_attempt_url": { + "nullable": true, + "description": "The URL to the previous attempted run of this workflow, if one exists.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3" + }, "workflow_url": { "description": "The URL to the workflow.", "type": "string", diff --git a/descriptions/ghes-3.0/ghes-3.0.yaml b/descriptions/ghes-3.0/ghes-3.0.yaml index 477dcee9c6..335f007533 100644 --- a/descriptions/ghes-3.0/ghes-3.0.yaml +++ b/descriptions/ghes-3.0/ghes-3.0.yaml @@ -13762,8 +13762,10 @@ paths: githubCloudOnly: false enabledForGitHubApps: false previews: [] + deprecationDate: '2021-09-14' category: actions subcategory: workflow-runs + deprecated: true "/repos/{owner}/{repo}/actions/secrets": get: summary: List repository secrets @@ -17460,7 +17462,9 @@ paths: \ \n\\* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. \n\\* `triage` - Recommended for contributors who need - to proactively manage issues and pull requests without write access." + to proactively manage issues and pull requests without write access. + \n\\* custom repository role name - Can assign a custom repository + role if the owning organization has defined any." enum: - pull - push @@ -22989,8 +22993,6 @@ paths: "$ref": "#/components/responses/not_found" '410': "$ref": "#/components/responses/gone" - '415': - "$ref": "#/components/responses/preview_header_missing" x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -23002,15 +23004,6 @@ paths: ```shell application/vnd.github.mockingbird-preview ``` - - required: false - name: starfox - note: |- - Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the [blog post](https://developer.github.com/changes/2018-09-05-project-card-events). - - To receive the `project_card` attribute, project boards must be [enabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) for a repository, and you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header: - ```shell - application/vnd.github.starfox-preview+json - ``` category: issues subcategory: timeline "/repos/{owner}/{repo}/keys": @@ -41682,6 +41675,11 @@ components: type: integer description: The auto incrementing run number for the workflow run. example: 106 + run_attempt: + type: integer + description: Attempt number of the run, 1 for first attempt and higher if + the workflow was retried. + example: 1 event: type: string example: push @@ -41739,6 +41737,12 @@ components: description: The URL to rerun the workflow run. type: string example: https://api.github.com/repos/github/hello-world/actions/runs/5/rerun + previous_attempt_url: + nullable: true + description: The URL to the previous attempted run of this workflow, if + one exists. + type: string + example: https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3 workflow_url: description: The URL to the workflow. type: string diff --git a/descriptions/ghes-3.1/dereferenced/ghes-3.1.deref.json b/descriptions/ghes-3.1/dereferenced/ghes-3.1.deref.json index b0cb85cd7a..b64b9d61f8 100644 --- a/descriptions/ghes-3.1/dereferenced/ghes-3.1.deref.json +++ b/descriptions/ghes-3.1/dereferenced/ghes-3.1.deref.json @@ -115195,6 +115195,11 @@ "description": "The auto incrementing run number for the workflow run.", "example": 106 }, + "run_attempt": { + "type": "integer", + "description": "Attempt number of the run, 1 for first attempt and higher if the workflow was retried.", + "example": 1 + }, "event": { "type": "string", "example": "push" @@ -115357,6 +115362,12 @@ "type": "string", "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/rerun" }, + "previous_attempt_url": { + "nullable": true, + "description": "The URL to the previous attempted run of this workflow, if one exists.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3" + }, "workflow_url": { "description": "The URL to the workflow.", "type": "string", @@ -119065,6 +119076,11 @@ "description": "The auto incrementing run number for the workflow run.", "example": 106 }, + "run_attempt": { + "type": "integer", + "description": "Attempt number of the run, 1 for first attempt and higher if the workflow was retried.", + "example": 1 + }, "event": { "type": "string", "example": "push" @@ -119227,6 +119243,12 @@ "type": "string", "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/rerun" }, + "previous_attempt_url": { + "nullable": true, + "description": "The URL to the previous attempted run of this workflow, if one exists.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3" + }, "workflow_url": { "description": "The URL to the workflow.", "type": "string", @@ -123689,9 +123711,11 @@ "previews": [ ], + "deprecationDate": "2021-09-14", "category": "actions", "subcategory": "workflow-runs" - } + }, + "deprecated": true } }, "/repos/{owner}/{repo}/actions/secrets": { @@ -124919,6 +124943,11 @@ "description": "The auto incrementing run number for the workflow run.", "example": 106 }, + "run_attempt": { + "type": "integer", + "description": "Attempt number of the run, 1 for first attempt and higher if the workflow was retried.", + "example": 1 + }, "event": { "type": "string", "example": "push" @@ -125081,6 +125110,12 @@ "type": "string", "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/rerun" }, + "previous_attempt_url": { + "nullable": true, + "description": "The URL to the previous attempted run of this workflow, if one exists.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3" + }, "workflow_url": { "description": "The URL to the workflow.", "type": "string", @@ -160533,7 +160568,7 @@ "properties": { "permission": { "type": "string", - "description": "The permission to grant the collaborator. **Only valid on organization-owned repositories.** Can be one of: \n\\* `pull` - can pull, but not push to or administer this repository. \n\\* `push` - can pull and push, but not administer this repository. \n\\* `admin` - can pull, push and administer this repository. \n\\* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. \n\\* `triage` - Recommended for contributors who need to proactively manage issues and pull requests without write access.", + "description": "The permission to grant the collaborator. **Only valid on organization-owned repositories.** Can be one of: \n\\* `pull` - can pull, but not push to or administer this repository. \n\\* `push` - can pull and push, but not administer this repository. \n\\* `admin` - can pull, push and administer this repository. \n\\* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. \n\\* `triage` - Recommended for contributors who need to proactively manage issues and pull requests without write access. \n\\* custom repository role name - Can assign a custom repository role if the owning organization has defined any.", "enum": [ "pull", "push", @@ -256005,28 +256040,6 @@ } } } - }, - "415": { - "description": "Preview header missing", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } } }, "x-github": { @@ -256037,11 +256050,6 @@ "required": true, "name": "mockingbird", "note": "The API to get issue timeline events is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-23-timeline-preview-api/) for full details. To access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@3.1/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mockingbird-preview\n```" - }, - { - "required": false, - "name": "starfox", - "note": "Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the [blog post](https://developer.github.com/changes/2018-09-05-project-card-events).\n\nTo receive the `project_card` attribute, project boards must be [enabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) for a repository, and you must provide a custom [media type](https://docs.github.com/enterprise-server@3.1/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.starfox-preview+json\n```" } ], "category": "issues", diff --git a/descriptions/ghes-3.1/dereferenced/ghes-3.1.deref.yaml b/descriptions/ghes-3.1/dereferenced/ghes-3.1.deref.yaml index fe5be99db8..3a80ea1d9b 100644 --- a/descriptions/ghes-3.1/dereferenced/ghes-3.1.deref.yaml +++ b/descriptions/ghes-3.1/dereferenced/ghes-3.1.deref.yaml @@ -28933,6 +28933,11 @@ paths: description: The auto incrementing run number for the workflow run. example: 106 + run_attempt: + type: integer + description: Attempt number of the run, 1 for first attempt + and higher if the workflow was retried. + example: 1 event: type: string example: push @@ -29053,6 +29058,12 @@ paths: description: The URL to rerun the workflow run. type: string example: https://api.github.com/repos/github/hello-world/actions/runs/5/rerun + previous_attempt_url: + nullable: true + description: The URL to the previous attempted run of this + workflow, if one exists. + type: string + example: https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3 workflow_url: description: The URL to the workflow. type: string @@ -29959,8 +29970,10 @@ paths: githubCloudOnly: false enabledForGitHubApps: false previews: [] + deprecationDate: '2021-09-14' category: actions subcategory: workflow-runs + deprecated: true "/repos/{owner}/{repo}/actions/secrets": get: summary: List repository secrets @@ -38398,7 +38411,9 @@ paths: \ \n\\* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. \n\\* `triage` - Recommended for contributors who need - to proactively manage issues and pull requests without write access." + to proactively manage issues and pull requests without write access. + \n\\* custom repository role name - Can assign a custom repository + role if the owning organization has defined any." enum: - pull - push @@ -52305,9 +52320,6 @@ paths: '410': description: Gone content: *166 - '415': - description: Preview header missing - content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52319,15 +52331,6 @@ paths: ```shell application/vnd.github.mockingbird-preview ``` - - required: false - name: starfox - note: |- - Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the [blog post](https://developer.github.com/changes/2018-09-05-project-card-events). - - To receive the `project_card` attribute, project boards must be [enabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) for a repository, and you must provide a custom [media type](https://docs.github.com/enterprise-server@3.1/rest/overview/media-types) in the `Accept` header: - ```shell - application/vnd.github.starfox-preview+json - ``` category: issues subcategory: timeline "/repos/{owner}/{repo}/keys": diff --git a/descriptions/ghes-3.1/ghes-3.1.json b/descriptions/ghes-3.1/ghes-3.1.json index 68b901fe3c..b809c6f19d 100644 --- a/descriptions/ghes-3.1/ghes-3.1.json +++ b/descriptions/ghes-3.1/ghes-3.1.json @@ -19335,9 +19335,11 @@ "previews": [ ], + "deprecationDate": "2021-09-14", "category": "actions", "subcategory": "workflow-runs" - } + }, + "deprecated": true } }, "/repos/{owner}/{repo}/actions/secrets": { @@ -24751,7 +24753,7 @@ "properties": { "permission": { "type": "string", - "description": "The permission to grant the collaborator. **Only valid on organization-owned repositories.** Can be one of: \n\\* `pull` - can pull, but not push to or administer this repository. \n\\* `push` - can pull and push, but not administer this repository. \n\\* `admin` - can pull, push and administer this repository. \n\\* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. \n\\* `triage` - Recommended for contributors who need to proactively manage issues and pull requests without write access.", + "description": "The permission to grant the collaborator. **Only valid on organization-owned repositories.** Can be one of: \n\\* `pull` - can pull, but not push to or administer this repository. \n\\* `push` - can pull and push, but not administer this repository. \n\\* `admin` - can pull, push and administer this repository. \n\\* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. \n\\* `triage` - Recommended for contributors who need to proactively manage issues and pull requests without write access. \n\\* custom repository role name - Can assign a custom repository role if the owning organization has defined any.", "enum": [ "pull", "push", @@ -32286,9 +32288,6 @@ }, "410": { "$ref": "#/components/responses/gone" - }, - "415": { - "$ref": "#/components/responses/preview_header_missing" } }, "x-github": { @@ -32299,11 +32298,6 @@ "required": true, "name": "mockingbird", "note": "The API to get issue timeline events is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-23-timeline-preview-api/) for full details. To access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@3.1/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mockingbird-preview\n```" - }, - { - "required": false, - "name": "starfox", - "note": "Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the [blog post](https://developer.github.com/changes/2018-09-05-project-card-events).\n\nTo receive the `project_card` attribute, project boards must be [enabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) for a repository, and you must provide a custom [media type](https://docs.github.com/enterprise-server@3.1/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.starfox-preview+json\n```" } ], "category": "issues", @@ -57945,6 +57939,11 @@ "description": "The auto incrementing run number for the workflow run.", "example": 106 }, + "run_attempt": { + "type": "integer", + "description": "Attempt number of the run, 1 for first attempt and higher if the workflow was retried.", + "example": 1 + }, "event": { "type": "string", "example": "push" @@ -58018,6 +58017,12 @@ "type": "string", "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/rerun" }, + "previous_attempt_url": { + "nullable": true, + "description": "The URL to the previous attempted run of this workflow, if one exists.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3" + }, "workflow_url": { "description": "The URL to the workflow.", "type": "string", diff --git a/descriptions/ghes-3.1/ghes-3.1.yaml b/descriptions/ghes-3.1/ghes-3.1.yaml index 713171347f..2330ad3666 100644 --- a/descriptions/ghes-3.1/ghes-3.1.yaml +++ b/descriptions/ghes-3.1/ghes-3.1.yaml @@ -13802,8 +13802,10 @@ paths: githubCloudOnly: false enabledForGitHubApps: false previews: [] + deprecationDate: '2021-09-14' category: actions subcategory: workflow-runs + deprecated: true "/repos/{owner}/{repo}/actions/secrets": get: summary: List repository secrets @@ -17842,7 +17844,9 @@ paths: \ \n\\* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. \n\\* `triage` - Recommended for contributors who need - to proactively manage issues and pull requests without write access." + to proactively manage issues and pull requests without write access. + \n\\* custom repository role name - Can assign a custom repository + role if the owning organization has defined any." enum: - pull - push @@ -23371,8 +23375,6 @@ paths: "$ref": "#/components/responses/not_found" '410': "$ref": "#/components/responses/gone" - '415': - "$ref": "#/components/responses/preview_header_missing" x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -23384,15 +23386,6 @@ paths: ```shell application/vnd.github.mockingbird-preview ``` - - required: false - name: starfox - note: |- - Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the [blog post](https://developer.github.com/changes/2018-09-05-project-card-events). - - To receive the `project_card` attribute, project boards must be [enabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) for a repository, and you must provide a custom [media type](https://docs.github.com/enterprise-server@3.1/rest/overview/media-types) in the `Accept` header: - ```shell - application/vnd.github.starfox-preview+json - ``` category: issues subcategory: timeline "/repos/{owner}/{repo}/keys": @@ -42326,6 +42319,11 @@ components: type: integer description: The auto incrementing run number for the workflow run. example: 106 + run_attempt: + type: integer + description: Attempt number of the run, 1 for first attempt and higher if + the workflow was retried. + example: 1 event: type: string example: push @@ -42383,6 +42381,12 @@ components: description: The URL to rerun the workflow run. type: string example: https://api.github.com/repos/github/hello-world/actions/runs/5/rerun + previous_attempt_url: + nullable: true + description: The URL to the previous attempted run of this workflow, if + one exists. + type: string + example: https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3 workflow_url: description: The URL to the workflow. type: string diff --git a/descriptions/ghes-3.2/dereferenced/ghes-3.2.deref.json b/descriptions/ghes-3.2/dereferenced/ghes-3.2.deref.json index 05c98c6cef..ecf1fa6e50 100644 --- a/descriptions/ghes-3.2/dereferenced/ghes-3.2.deref.json +++ b/descriptions/ghes-3.2/dereferenced/ghes-3.2.deref.json @@ -117413,6 +117413,11 @@ "description": "The auto incrementing run number for the workflow run.", "example": 106 }, + "run_attempt": { + "type": "integer", + "description": "Attempt number of the run, 1 for first attempt and higher if the workflow was retried.", + "example": 1 + }, "event": { "type": "string", "example": "push" @@ -117575,6 +117580,12 @@ "type": "string", "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/rerun" }, + "previous_attempt_url": { + "nullable": true, + "description": "The URL to the previous attempted run of this workflow, if one exists.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3" + }, "workflow_url": { "description": "The URL to the workflow.", "type": "string", @@ -121301,6 +121312,11 @@ "description": "The auto incrementing run number for the workflow run.", "example": 106 }, + "run_attempt": { + "type": "integer", + "description": "Attempt number of the run, 1 for first attempt and higher if the workflow was retried.", + "example": 1 + }, "event": { "type": "string", "example": "push" @@ -121463,6 +121479,12 @@ "type": "string", "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/rerun" }, + "previous_attempt_url": { + "nullable": true, + "description": "The URL to the previous attempted run of this workflow, if one exists.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3" + }, "workflow_url": { "description": "The URL to the workflow.", "type": "string", @@ -127340,9 +127362,11 @@ "previews": [ ], + "deprecationDate": "2021-09-14", "category": "actions", "subcategory": "workflow-runs" - } + }, + "deprecated": true } }, "/repos/{owner}/{repo}/actions/secrets": { @@ -128570,6 +128594,11 @@ "description": "The auto incrementing run number for the workflow run.", "example": 106 }, + "run_attempt": { + "type": "integer", + "description": "Attempt number of the run, 1 for first attempt and higher if the workflow was retried.", + "example": 1 + }, "event": { "type": "string", "example": "push" @@ -128732,6 +128761,12 @@ "type": "string", "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/rerun" }, + "previous_attempt_url": { + "nullable": true, + "description": "The URL to the previous attempted run of this workflow, if one exists.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3" + }, "workflow_url": { "description": "The URL to the workflow.", "type": "string", @@ -164272,7 +164307,7 @@ "properties": { "permission": { "type": "string", - "description": "The permission to grant the collaborator. **Only valid on organization-owned repositories.** Can be one of: \n\\* `pull` - can pull, but not push to or administer this repository. \n\\* `push` - can pull and push, but not administer this repository. \n\\* `admin` - can pull, push and administer this repository. \n\\* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. \n\\* `triage` - Recommended for contributors who need to proactively manage issues and pull requests without write access.", + "description": "The permission to grant the collaborator. **Only valid on organization-owned repositories.** Can be one of: \n\\* `pull` - can pull, but not push to or administer this repository. \n\\* `push` - can pull and push, but not administer this repository. \n\\* `admin` - can pull, push and administer this repository. \n\\* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. \n\\* `triage` - Recommended for contributors who need to proactively manage issues and pull requests without write access. \n\\* custom repository role name - Can assign a custom repository role if the owning organization has defined any.", "enum": [ "pull", "push", @@ -262817,28 +262852,6 @@ } } } - }, - "415": { - "description": "Preview header missing", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } } }, "x-github": { @@ -262849,11 +262862,6 @@ "required": true, "name": "mockingbird", "note": "The API to get issue timeline events is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-23-timeline-preview-api/) for full details. To access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mockingbird-preview\n```" - }, - { - "required": false, - "name": "starfox", - "note": "Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the [blog post](https://developer.github.com/changes/2018-09-05-project-card-events).\n\nTo receive the `project_card` attribute, project boards must be [enabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) for a repository, and you must provide a custom [media type](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.starfox-preview+json\n```" } ], "category": "issues", diff --git a/descriptions/ghes-3.2/dereferenced/ghes-3.2.deref.yaml b/descriptions/ghes-3.2/dereferenced/ghes-3.2.deref.yaml index 23db60a742..f722a41b13 100644 --- a/descriptions/ghes-3.2/dereferenced/ghes-3.2.deref.yaml +++ b/descriptions/ghes-3.2/dereferenced/ghes-3.2.deref.yaml @@ -29607,6 +29607,11 @@ paths: description: The auto incrementing run number for the workflow run. example: 106 + run_attempt: + type: integer + description: Attempt number of the run, 1 for first attempt + and higher if the workflow was retried. + example: 1 event: type: string example: push @@ -29727,6 +29732,12 @@ paths: description: The URL to rerun the workflow run. type: string example: https://api.github.com/repos/github/hello-world/actions/runs/5/rerun + previous_attempt_url: + nullable: true + description: The URL to the previous attempted run of this + workflow, if one exists. + type: string + example: https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3 workflow_url: description: The URL to the workflow. type: string @@ -31146,8 +31157,10 @@ paths: githubCloudOnly: false enabledForGitHubApps: false previews: [] + deprecationDate: '2021-09-14' category: actions subcategory: workflow-runs + deprecated: true "/repos/{owner}/{repo}/actions/secrets": get: summary: List repository secrets @@ -39570,7 +39583,9 @@ paths: \ \n\\* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. \n\\* `triage` - Recommended for contributors who need - to proactively manage issues and pull requests without write access." + to proactively manage issues and pull requests without write access. + \n\\* custom repository role name - Can assign a custom repository + role if the owning organization has defined any." enum: - pull - push @@ -54013,9 +54028,6 @@ paths: '410': description: Gone content: *176 - '415': - description: Preview header missing - content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54027,15 +54039,6 @@ paths: ```shell application/vnd.github.mockingbird-preview ``` - - required: false - name: starfox - note: |- - Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the [blog post](https://developer.github.com/changes/2018-09-05-project-card-events). - - To receive the `project_card` attribute, project boards must be [enabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) for a repository, and you must provide a custom [media type](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types) in the `Accept` header: - ```shell - application/vnd.github.starfox-preview+json - ``` category: issues subcategory: timeline "/repos/{owner}/{repo}/keys": diff --git a/descriptions/ghes-3.2/ghes-3.2.json b/descriptions/ghes-3.2/ghes-3.2.json index 09d4e309b6..eb5e177d4e 100644 --- a/descriptions/ghes-3.2/ghes-3.2.json +++ b/descriptions/ghes-3.2/ghes-3.2.json @@ -19887,9 +19887,11 @@ "previews": [ ], + "deprecationDate": "2021-09-14", "category": "actions", "subcategory": "workflow-runs" - } + }, + "deprecated": true } }, "/repos/{owner}/{repo}/actions/secrets": { @@ -25303,7 +25305,7 @@ "properties": { "permission": { "type": "string", - "description": "The permission to grant the collaborator. **Only valid on organization-owned repositories.** Can be one of: \n\\* `pull` - can pull, but not push to or administer this repository. \n\\* `push` - can pull and push, but not administer this repository. \n\\* `admin` - can pull, push and administer this repository. \n\\* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. \n\\* `triage` - Recommended for contributors who need to proactively manage issues and pull requests without write access.", + "description": "The permission to grant the collaborator. **Only valid on organization-owned repositories.** Can be one of: \n\\* `pull` - can pull, but not push to or administer this repository. \n\\* `push` - can pull and push, but not administer this repository. \n\\* `admin` - can pull, push and administer this repository. \n\\* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. \n\\* `triage` - Recommended for contributors who need to proactively manage issues and pull requests without write access. \n\\* custom repository role name - Can assign a custom repository role if the owning organization has defined any.", "enum": [ "pull", "push", @@ -33263,9 +33265,6 @@ }, "410": { "$ref": "#/components/responses/gone" - }, - "415": { - "$ref": "#/components/responses/preview_header_missing" } }, "x-github": { @@ -33276,11 +33275,6 @@ "required": true, "name": "mockingbird", "note": "The API to get issue timeline events is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-23-timeline-preview-api/) for full details. To access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mockingbird-preview\n```" - }, - { - "required": false, - "name": "starfox", - "note": "Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the [blog post](https://developer.github.com/changes/2018-09-05-project-card-events).\n\nTo receive the `project_card` attribute, project boards must be [enabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) for a repository, and you must provide a custom [media type](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.starfox-preview+json\n```" } ], "category": "issues", @@ -59653,6 +59647,11 @@ "description": "The auto incrementing run number for the workflow run.", "example": 106 }, + "run_attempt": { + "type": "integer", + "description": "Attempt number of the run, 1 for first attempt and higher if the workflow was retried.", + "example": 1 + }, "event": { "type": "string", "example": "push" @@ -59726,6 +59725,12 @@ "type": "string", "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/rerun" }, + "previous_attempt_url": { + "nullable": true, + "description": "The URL to the previous attempted run of this workflow, if one exists.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3" + }, "workflow_url": { "description": "The URL to the workflow.", "type": "string", diff --git a/descriptions/ghes-3.2/ghes-3.2.yaml b/descriptions/ghes-3.2/ghes-3.2.yaml index 0683a6dfc3..f8b3561ce3 100644 --- a/descriptions/ghes-3.2/ghes-3.2.yaml +++ b/descriptions/ghes-3.2/ghes-3.2.yaml @@ -14176,8 +14176,10 @@ paths: githubCloudOnly: false enabledForGitHubApps: false previews: [] + deprecationDate: '2021-09-14' category: actions subcategory: workflow-runs + deprecated: true "/repos/{owner}/{repo}/actions/secrets": get: summary: List repository secrets @@ -18216,7 +18218,9 @@ paths: \ \n\\* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. \n\\* `triage` - Recommended for contributors who need - to proactively manage issues and pull requests without write access." + to proactively manage issues and pull requests without write access. + \n\\* custom repository role name - Can assign a custom repository + role if the owning organization has defined any." enum: - pull - push @@ -24018,8 +24022,6 @@ paths: "$ref": "#/components/responses/not_found" '410': "$ref": "#/components/responses/gone" - '415': - "$ref": "#/components/responses/preview_header_missing" x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24031,15 +24033,6 @@ paths: ```shell application/vnd.github.mockingbird-preview ``` - - required: false - name: starfox - note: |- - Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the [blog post](https://developer.github.com/changes/2018-09-05-project-card-events). - - To receive the `project_card` attribute, project boards must be [enabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) for a repository, and you must provide a custom [media type](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types) in the `Accept` header: - ```shell - application/vnd.github.starfox-preview+json - ``` category: issues subcategory: timeline "/repos/{owner}/{repo}/keys": @@ -43586,6 +43579,11 @@ components: type: integer description: The auto incrementing run number for the workflow run. example: 106 + run_attempt: + type: integer + description: Attempt number of the run, 1 for first attempt and higher if + the workflow was retried. + example: 1 event: type: string example: push @@ -43643,6 +43641,12 @@ components: description: The URL to rerun the workflow run. type: string example: https://api.github.com/repos/github/hello-world/actions/runs/5/rerun + previous_attempt_url: + nullable: true + description: The URL to the previous attempted run of this workflow, if + one exists. + type: string + example: https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3 workflow_url: description: The URL to the workflow. type: string diff --git a/descriptions/github.ae/dereferenced/github.ae.deref.json b/descriptions/github.ae/dereferenced/github.ae.deref.json index bbdc8f53ee..fdfe214cf9 100644 --- a/descriptions/github.ae/dereferenced/github.ae.deref.json +++ b/descriptions/github.ae/dereferenced/github.ae.deref.json @@ -85905,6 +85905,11 @@ "description": "The auto incrementing run number for the workflow run.", "example": 106 }, + "run_attempt": { + "type": "integer", + "description": "Attempt number of the run, 1 for first attempt and higher if the workflow was retried.", + "example": 1 + }, "event": { "type": "string", "example": "push" @@ -86067,6 +86072,12 @@ "type": "string", "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/rerun" }, + "previous_attempt_url": { + "nullable": true, + "description": "The URL to the previous attempted run of this workflow, if one exists.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3" + }, "workflow_url": { "description": "The URL to the workflow.", "type": "string", @@ -89793,6 +89804,11 @@ "description": "The auto incrementing run number for the workflow run.", "example": 106 }, + "run_attempt": { + "type": "integer", + "description": "Attempt number of the run, 1 for first attempt and higher if the workflow was retried.", + "example": 1 + }, "event": { "type": "string", "example": "push" @@ -89955,6 +89971,12 @@ "type": "string", "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/rerun" }, + "previous_attempt_url": { + "nullable": true, + "description": "The URL to the previous attempted run of this workflow, if one exists.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3" + }, "workflow_url": { "description": "The URL to the workflow.", "type": "string", @@ -94435,9 +94457,11 @@ "previews": [ ], + "deprecationDate": "2021-09-14", "category": "actions", "subcategory": "workflow-runs" - } + }, + "deprecated": true } }, "/repos/{owner}/{repo}/actions/runs/{run_id}/retry": { @@ -95873,6 +95897,11 @@ "description": "The auto incrementing run number for the workflow run.", "example": 106 }, + "run_attempt": { + "type": "integer", + "description": "Attempt number of the run, 1 for first attempt and higher if the workflow was retried.", + "example": 1 + }, "event": { "type": "string", "example": "push" @@ -96035,6 +96064,12 @@ "type": "string", "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/rerun" }, + "previous_attempt_url": { + "nullable": true, + "description": "The URL to the previous attempted run of this workflow, if one exists.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3" + }, "workflow_url": { "description": "The URL to the workflow.", "type": "string", @@ -130382,7 +130417,7 @@ "properties": { "permission": { "type": "string", - "description": "The permission to grant the collaborator. **Only valid on organization-owned repositories.** Can be one of: \n\\* `pull` - can pull, but not push to or administer this repository. \n\\* `push` - can pull and push, but not administer this repository. \n\\* `admin` - can pull, push and administer this repository. \n\\* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. \n\\* `triage` - Recommended for contributors who need to proactively manage issues and pull requests without write access.", + "description": "The permission to grant the collaborator. **Only valid on organization-owned repositories.** Can be one of: \n\\* `pull` - can pull, but not push to or administer this repository. \n\\* `push` - can pull and push, but not administer this repository. \n\\* `admin` - can pull, push and administer this repository. \n\\* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. \n\\* `triage` - Recommended for contributors who need to proactively manage issues and pull requests without write access. \n\\* custom repository role name - Can assign a custom repository role if the owning organization has defined any.", "enum": [ "pull", "push", @@ -226866,39 +226901,12 @@ } } } - }, - "415": { - "description": "Preview header missing", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [ - { - "required": true, - "name": "mockingbird", - "note": "The API to get issue timeline events is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-23-timeline-preview-api/) for full details. To access the API you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mockingbird-preview\n```" - }, { "required": false, "name": "starfox", @@ -228276,14 +228284,14 @@ "/repos/{owner}/{repo}/lfs": { "put": { "summary": "Enable Git LFS for a repository", - "description": "", - "operationId": "enterprise-admin/enable-lfs-for-repo", + "description": "**Note:** The Git LFS API endpoints are currently in beta and are subject to change.", + "operationId": "repos/enable-lfs-for-repo", "tags": [ - "enterprise-admin" + "repos" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#enable-git-lfs-for-a-repository" + "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#enable-git-lfs-for-a-repository" }, "parameters": [ { @@ -228324,20 +228332,20 @@ "previews": [ ], - "category": "enterprise-admin", + "category": "repos", "subcategory": "lfs" } }, "delete": { "summary": "Disable Git LFS for a repository", - "description": "", - "operationId": "enterprise-admin/disable-lfs-for-repo", + "description": "**Note:** The Git LFS API endpoints are currently in beta and are subject to change.", + "operationId": "repos/disable-lfs-for-repo", "tags": [ - "enterprise-admin" + "repos" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#disable-git-lfs-for-a-repository" + "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#disable-git-lfs-for-a-repository" }, "parameters": [ { @@ -228368,7 +228376,7 @@ "previews": [ ], - "category": "enterprise-admin", + "category": "repos", "subcategory": "lfs" } } diff --git a/descriptions/github.ae/dereferenced/github.ae.deref.yaml b/descriptions/github.ae/dereferenced/github.ae.deref.yaml index 273d5e0673..4fd88c6158 100644 --- a/descriptions/github.ae/dereferenced/github.ae.deref.yaml +++ b/descriptions/github.ae/dereferenced/github.ae.deref.yaml @@ -24844,6 +24844,11 @@ paths: description: The auto incrementing run number for the workflow run. example: 106 + run_attempt: + type: integer + description: Attempt number of the run, 1 for first attempt + and higher if the workflow was retried. + example: 1 event: type: string example: push @@ -24964,6 +24969,12 @@ paths: description: The URL to rerun the workflow run. type: string example: https://api.github.com/repos/github/hello-world/actions/runs/5/rerun + previous_attempt_url: + nullable: true + description: The URL to the previous attempted run of this + workflow, if one exists. + type: string + example: https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3 workflow_url: description: The URL to the workflow. type: string @@ -25873,8 +25884,10 @@ paths: githubCloudOnly: false enabledForGitHubApps: false previews: [] + deprecationDate: '2021-09-14' category: actions subcategory: workflow-runs + deprecated: true "/repos/{owner}/{repo}/actions/runs/{run_id}/retry": post: summary: Retry a workflow @@ -34416,7 +34429,9 @@ paths: \ \n\\* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. \n\\* `triage` - Recommended for contributors who need - to proactively manage issues and pull requests without write access." + to proactively manage issues and pull requests without write access. + \n\\* custom repository role name - Can assign a custom repository + role if the owning organization has defined any." enum: - pull - push @@ -48821,20 +48836,10 @@ paths: '410': description: Gone content: *181 - '415': - description: Preview header missing - content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true previews: - - required: true - name: mockingbird - note: |- - The API to get issue timeline events is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-23-timeline-preview-api/) for full details. To access the API you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header: - ```shell - application/vnd.github.mockingbird-preview - ``` - required: false name: starfox note: |- @@ -49432,13 +49437,14 @@ paths: "/repos/{owner}/{repo}/lfs": put: summary: Enable Git LFS for a repository - description: '' - operationId: enterprise-admin/enable-lfs-for-repo + description: "**Note:** The Git LFS API endpoints are currently in beta and + are subject to change." + operationId: repos/enable-lfs-for-repo tags: - - enterprise-admin + - repos externalDocs: description: API method documentation - url: https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#enable-git-lfs-for-a-repository + url: https://docs.github.com/github-ae@latest/rest/reference/repos#enable-git-lfs-for-a-repository parameters: - name: owner in: path @@ -49463,17 +49469,18 @@ paths: githubCloudOnly: false enabledForGitHubApps: false previews: [] - category: enterprise-admin + category: repos subcategory: lfs delete: summary: Disable Git LFS for a repository - description: '' - operationId: enterprise-admin/disable-lfs-for-repo + description: "**Note:** The Git LFS API endpoints are currently in beta and + are subject to change." + operationId: repos/disable-lfs-for-repo tags: - - enterprise-admin + - repos externalDocs: description: API method documentation - url: https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#disable-git-lfs-for-a-repository + url: https://docs.github.com/github-ae@latest/rest/reference/repos#disable-git-lfs-for-a-repository parameters: - name: owner in: path @@ -49490,7 +49497,7 @@ paths: githubCloudOnly: false enabledForGitHubApps: false previews: [] - category: enterprise-admin + category: repos subcategory: lfs "/repos/{owner}/{repo}/license": get: diff --git a/descriptions/github.ae/github.ae.json b/descriptions/github.ae/github.ae.json index 11e74e6c9c..19bb2c17a6 100644 --- a/descriptions/github.ae/github.ae.json +++ b/descriptions/github.ae/github.ae.json @@ -15949,9 +15949,11 @@ "previews": [ ], + "deprecationDate": "2021-09-14", "category": "actions", "subcategory": "workflow-runs" - } + }, + "deprecated": true } }, "/repos/{owner}/{repo}/actions/runs/{run_id}/retry": { @@ -21592,7 +21594,7 @@ "properties": { "permission": { "type": "string", - "description": "The permission to grant the collaborator. **Only valid on organization-owned repositories.** Can be one of: \n\\* `pull` - can pull, but not push to or administer this repository. \n\\* `push` - can pull and push, but not administer this repository. \n\\* `admin` - can pull, push and administer this repository. \n\\* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. \n\\* `triage` - Recommended for contributors who need to proactively manage issues and pull requests without write access.", + "description": "The permission to grant the collaborator. **Only valid on organization-owned repositories.** Can be one of: \n\\* `pull` - can pull, but not push to or administer this repository. \n\\* `push` - can pull and push, but not administer this repository. \n\\* `admin` - can pull, push and administer this repository. \n\\* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. \n\\* `triage` - Recommended for contributors who need to proactively manage issues and pull requests without write access. \n\\* custom repository role name - Can assign a custom repository role if the owning organization has defined any.", "enum": [ "pull", "push", @@ -29234,20 +29236,12 @@ }, "410": { "$ref": "#/components/responses/gone" - }, - "415": { - "$ref": "#/components/responses/preview_header_missing" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [ - { - "required": true, - "name": "mockingbird", - "note": "The API to get issue timeline events is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-23-timeline-preview-api/) for full details. To access the API you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mockingbird-preview\n```" - }, { "required": false, "name": "starfox", @@ -29892,14 +29886,14 @@ "/repos/{owner}/{repo}/lfs": { "put": { "summary": "Enable Git LFS for a repository", - "description": "", - "operationId": "enterprise-admin/enable-lfs-for-repo", + "description": "**Note:** The Git LFS API endpoints are currently in beta and are subject to change.", + "operationId": "repos/enable-lfs-for-repo", "tags": [ - "enterprise-admin" + "repos" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#enable-git-lfs-for-a-repository" + "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#enable-git-lfs-for-a-repository" }, "parameters": [ { @@ -29923,20 +29917,20 @@ "previews": [ ], - "category": "enterprise-admin", + "category": "repos", "subcategory": "lfs" } }, "delete": { "summary": "Disable Git LFS for a repository", - "description": "", - "operationId": "enterprise-admin/disable-lfs-for-repo", + "description": "**Note:** The Git LFS API endpoints are currently in beta and are subject to change.", + "operationId": "repos/disable-lfs-for-repo", "tags": [ - "enterprise-admin" + "repos" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#disable-git-lfs-for-a-repository" + "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#disable-git-lfs-for-a-repository" }, "parameters": [ { @@ -29957,7 +29951,7 @@ "previews": [ ], - "category": "enterprise-admin", + "category": "repos", "subcategory": "lfs" } } @@ -53313,6 +53307,11 @@ "description": "The auto incrementing run number for the workflow run.", "example": 106 }, + "run_attempt": { + "type": "integer", + "description": "Attempt number of the run, 1 for first attempt and higher if the workflow was retried.", + "example": 1 + }, "event": { "type": "string", "example": "push" @@ -53386,6 +53385,12 @@ "type": "string", "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/rerun" }, + "previous_attempt_url": { + "nullable": true, + "description": "The URL to the previous attempted run of this workflow, if one exists.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3" + }, "workflow_url": { "description": "The URL to the workflow.", "type": "string", diff --git a/descriptions/github.ae/github.ae.yaml b/descriptions/github.ae/github.ae.yaml index 5fc14a46d7..3b9105d555 100644 --- a/descriptions/github.ae/github.ae.yaml +++ b/descriptions/github.ae/github.ae.yaml @@ -11403,8 +11403,10 @@ paths: githubCloudOnly: false enabledForGitHubApps: false previews: [] + deprecationDate: '2021-09-14' category: actions subcategory: workflow-runs + deprecated: true "/repos/{owner}/{repo}/actions/runs/{run_id}/retry": post: summary: Retry a workflow @@ -15504,7 +15506,9 @@ paths: \ \n\\* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. \n\\* `triage` - Recommended for contributors who need - to proactively manage issues and pull requests without write access." + to proactively manage issues and pull requests without write access. + \n\\* custom repository role name - Can assign a custom repository + role if the owning organization has defined any." enum: - pull - push @@ -21077,19 +21081,10 @@ paths: "$ref": "#/components/responses/not_found" '410': "$ref": "#/components/responses/gone" - '415': - "$ref": "#/components/responses/preview_header_missing" x-github: githubCloudOnly: false enabledForGitHubApps: true previews: - - required: true - name: mockingbird - note: |- - The API to get issue timeline events is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-23-timeline-preview-api/) for full details. To access the API you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header: - ```shell - application/vnd.github.mockingbird-preview - ``` - required: false name: starfox note: |- @@ -21509,13 +21504,14 @@ paths: "/repos/{owner}/{repo}/lfs": put: summary: Enable Git LFS for a repository - description: '' - operationId: enterprise-admin/enable-lfs-for-repo + description: "**Note:** The Git LFS API endpoints are currently in beta and + are subject to change." + operationId: repos/enable-lfs-for-repo tags: - - enterprise-admin + - repos externalDocs: description: API method documentation - url: https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#enable-git-lfs-for-a-repository + url: https://docs.github.com/github-ae@latest/rest/reference/repos#enable-git-lfs-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" @@ -21533,17 +21529,18 @@ paths: githubCloudOnly: false enabledForGitHubApps: false previews: [] - category: enterprise-admin + category: repos subcategory: lfs delete: summary: Disable Git LFS for a repository - description: '' - operationId: enterprise-admin/disable-lfs-for-repo + description: "**Note:** The Git LFS API endpoints are currently in beta and + are subject to change." + operationId: repos/disable-lfs-for-repo tags: - - enterprise-admin + - repos externalDocs: description: API method documentation - url: https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#disable-git-lfs-for-a-repository + url: https://docs.github.com/github-ae@latest/rest/reference/repos#disable-git-lfs-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" @@ -21554,7 +21551,7 @@ paths: githubCloudOnly: false enabledForGitHubApps: false previews: [] - category: enterprise-admin + category: repos subcategory: lfs "/repos/{owner}/{repo}/license": get: @@ -38848,6 +38845,11 @@ components: type: integer description: The auto incrementing run number for the workflow run. example: 106 + run_attempt: + type: integer + description: Attempt number of the run, 1 for first attempt and higher if + the workflow was retried. + example: 1 event: type: string example: push @@ -38905,6 +38907,12 @@ components: description: The URL to rerun the workflow run. type: string example: https://api.github.com/repos/github/hello-world/actions/runs/5/rerun + previous_attempt_url: + nullable: true + description: The URL to the previous attempted run of this workflow, if + one exists. + type: string + example: https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3 workflow_url: description: The URL to the workflow. type: string