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 (#288) WIP: schema updates Co-authored-by: Octokit Bot <[email protected]>
octokit · Sep 7, 2022 · 161e014 · 161e014
1 parent a0958e3
commit 161e014
Show file tree

Hide file tree

Showing 40 changed files with 5,991 additions and 1,648 deletions.
diff --git a/cache/api.github.com.deref.json b/cache/api.github.com.deref.json
diff --git a/cache/api.github.com.json b/cache/api.github.com.json
diff --git a/cache/ghes-3.2.deref.json b/cache/ghes-3.2.deref.json
@@ -85514,8 +85514,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",
@@ -111039,8 +111040,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",
@@ -131554,7 +131556,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/[email protected]/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"
@@ -191569,7 +191571,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.2.json b/cache/ghes-3.2.json
@@ -13538,8 +13538,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",
@@ -17871,8 +17872,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",
@@ -20114,7 +20116,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/[email protected]/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"
@@ -26991,7 +26993,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.deref.json b/cache/ghes-3.3.deref.json
@@ -86241,8 +86241,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",
@@ -112047,8 +112048,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",
@@ -132746,7 +132748,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/[email protected]/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"
@@ -193380,7 +193382,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
@@ -13412,8 +13412,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",
@@ -17550,8 +17551,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",
@@ -19782,7 +19784,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/[email protected]/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"
@@ -26860,7 +26862,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.deref.json b/cache/ghes-3.4.deref.json
@@ -94848,8 +94848,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",
@@ -120843,8 +120844,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",
@@ -142468,7 +142470,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/[email protected]/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"
@@ -206925,7 +206927,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
@@ -9236,7 +9236,7 @@
                 },
                 "examples": {
                   "default": {
-                    "$ref": "#/components/examples/organization-custom-repository-role-example-old"
+                    "$ref": "#/components/examples/organization-custom-repository-role-example"
                   }
                 }
               }
@@ -14716,8 +14716,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",
@@ -18905,8 +18906,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",
@@ -21406,7 +21408,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/[email protected]/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"
@@ -28448,7 +28450,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",
@@ -79785,7 +79787,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.deref.json b/cache/ghes-3.5.deref.json
@@ -96951,8 +96951,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",
@@ -122840,8 +122841,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",
@@ -150391,7 +150393,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/[email protected]/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"
@@ -215354,7 +215356,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",