feat: add new public beta APIs for creating, reading, updating and de…

…leting custom repo roles and return additional attributes on custom repo roles in existing APIs (#241) WIP
octokit · Sep 7, 2022 · 612a9cc · 612a9cc
1 parent caadd4b
commit 612a9cc
Show file tree

Hide file tree

Showing 21 changed files with 1,119 additions and 127 deletions.
diff --git a/cache/api.github.com.json b/cache/api.github.com.json
diff --git a/cache/ghes-3.2.json b/cache/ghes-3.2.json
@@ -1,7 +1,7 @@
 {
  "openapi": "3.0.3",
  "info": {
- "version": "7.9.1",
+ "version": "7.10.0",
  "title": "GitHub's official OpenAPI spec + Octokit extension",
  "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
  "license": {
@@ -13884,8 +13884,9 @@
  },
  "use_squash_pr_title_as_default": {
  "type": "boolean",
- "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.",
- "default": false
+ "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
+ "default": false,
+ "deprecated": true
  },
  "squash_merge_commit_title": {
  "type": "string",
@@ -18298,8 +18299,9 @@
  },
  "use_squash_pr_title_as_default": {
  "type": "boolean",
- "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.",
- "default": false
+ "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
+ "default": false,
+ "deprecated": true
  },
  "squash_merge_commit_title": {
  "type": "string",
@@ -20633,7 +20635,7 @@
  },
  "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": {
  "get": {
- "summary": "List workflow runs",
+ "summary": "List workflow runs for a workflow",
  "description": "List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.2/rest/overview/resources-in-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope.",
  "tags": [
  "actions"
@@ -27623,7 +27625,7 @@
  },
  "sha": {
  "type": "string",
- "description": "The blob SHA of the file being replaced."
+ "description": "The blob SHA of the file being deleted."
  },
  "branch": {
  "type": "string",

diff --git a/cache/ghes-3.3.json b/cache/ghes-3.3.json
@@ -1,7 +1,7 @@
 {
  "openapi": "3.0.3",
  "info": {
- "version": "7.9.1",
+ "version": "7.10.0",
  "title": "GitHub's official OpenAPI spec + Octokit extension",
  "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
  "license": {
@@ -13799,8 +13799,9 @@
  },
  "use_squash_pr_title_as_default": {
  "type": "boolean",
- "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.",
- "default": false
+ "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
+ "default": false,
+ "deprecated": true
  },
  "squash_merge_commit_title": {
  "type": "string",
@@ -18013,8 +18014,9 @@
  },
  "use_squash_pr_title_as_default": {
  "type": "boolean",
- "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.",
- "default": false
+ "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
+ "default": false,
+ "deprecated": true
  },
  "squash_merge_commit_title": {
  "type": "string",
@@ -20295,7 +20297,7 @@
  },
  "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": {
  "get": {
- "summary": "List workflow runs",
+ "summary": "List workflow runs for a workflow",
  "description": "List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.3/rest/overview/resources-in-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope.",
  "tags": [
  "actions"
@@ -27496,7 +27498,7 @@
  },
  "sha": {
  "type": "string",
- "description": "The blob SHA of the file being replaced."
+ "description": "The blob SHA of the file being deleted."
  },
  "branch": {
  "type": "string",

diff --git a/cache/ghes-3.4.json b/cache/ghes-3.4.json
@@ -1,7 +1,7 @@
 {
  "openapi": "3.0.3",
  "info": {
- "version": "7.9.1",
+ "version": "7.10.0",
  "title": "GitHub's official OpenAPI spec + Octokit extension",
  "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
  "license": {
@@ -9445,7 +9445,7 @@
  },
  "examples": {
  "default": {
- "$ref": "#/components/examples/organization-custom-repository-role-example-old"
+ "$ref": "#/components/examples/organization-custom-repository-role-example"
  }
  }
  }
@@ -15079,8 +15079,9 @@
  },
  "use_squash_pr_title_as_default": {
  "type": "boolean",
- "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.",
- "default": false
+ "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
+ "default": false,
+ "deprecated": true
  },
  "squash_merge_commit_title": {
  "type": "string",
@@ -19351,8 +19352,9 @@
  },
  "use_squash_pr_title_as_default": {
  "type": "boolean",
- "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.",
- "default": false
+ "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
+ "default": false,
+ "deprecated": true
  },
  "squash_merge_commit_title": {
  "type": "string",
@@ -21919,7 +21921,7 @@
  },
  "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": {
  "get": {
- "summary": "List workflow runs",
+ "summary": "List workflow runs for a workflow",
  "description": "List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.4/rest/overview/resources-in-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope.",
  "tags": [
  "actions"
@@ -29056,7 +29058,7 @@
  },
  "sha": {
  "type": "string",
- "description": "The blob SHA of the file being replaced."
+ "description": "The blob SHA of the file being deleted."
  },
  "branch": {
  "type": "string",
@@ -81501,7 +81503,7 @@
  }
  ]
  },
- "organization-custom-repository-role-example-old": {
+ "organization-custom-repository-role-example": {
  "value": {
  "total_count": 2,
  "custom_roles": [

diff --git a/cache/ghes-3.5.json b/cache/ghes-3.5.json
@@ -1,7 +1,7 @@
 {
  "openapi": "3.0.3",
  "info": {
- "version": "7.9.1",
+ "version": "7.10.0",
  "title": "GitHub's official OpenAPI spec + Octokit extension",
  "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
  "license": {
@@ -9637,7 +9637,7 @@
  },
  "examples": {
  "default": {
- "$ref": "#/components/examples/organization-custom-repository-role-example-old"
+ "$ref": "#/components/examples/organization-custom-repository-role-example"
  }
  }
  }
@@ -15658,8 +15658,9 @@
  },
  "use_squash_pr_title_as_default": {
  "type": "boolean",
- "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.",
- "default": false
+ "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
+ "default": false,
+ "deprecated": true
  },
  "squash_merge_commit_title": {
  "type": "string",
@@ -19908,8 +19909,9 @@
  },
  "use_squash_pr_title_as_default": {
  "type": "boolean",
- "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.",
- "default": false
+ "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
+ "default": false,
+ "deprecated": true
  },
  "squash_merge_commit_title": {
  "type": "string",
@@ -23072,7 +23074,7 @@
  },
  "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": {
  "get": {
- "summary": "List workflow runs",
+ "summary": "List workflow runs for a workflow",
  "description": "List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.5/rest/overview/resources-in-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope.",
  "tags": [
  "actions"
@@ -30276,7 +30278,7 @@
  },
  "sha": {
  "type": "string",
- "description": "The blob SHA of the file being replaced."
+ "description": "The blob SHA of the file being deleted."
  },
  "branch": {
  "type": "string",
@@ -83151,7 +83153,7 @@
  }
  ]
  },
- "organization-custom-repository-role-example-old": {
+ "organization-custom-repository-role-example": {
  "value": {
  "total_count": 2,
  "custom_roles": [