@octokit/openapi 6.6.0 → 6.6.3

package/generated/ghes-3.4.deref.json

@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "version": "6.6.0",
+    "version": "6.6.3",
     "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": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
@@ -13191,6 +13191,18 @@
                     "type": "string"
                   }
                 }
+              },
+              "examples": {
+                "default": {
+                  "summary": "Create an authorization",
+                  "value": {
+                    "scopes": ["public_repo"],
+                    "note": "optional note",
+                    "note_url": "http://optional/note/url",
+                    "client_id": "abcde12345fghij67890",
+                    "client_secret": "3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f"
+                  }
+                }
               }
             }
           }
@@ -13819,9 +13831,9 @@
             "name": "client_id",
             "in": "path",
             "required": true,
-            "description": "The client ID of the GitHub app.",
+            "description": "The client ID of the OAuth app.",
             "schema": { "type": "string" },
-            "examples": { "default": { "value": "Iv1.8a61f9b3a7aba766" } }
+            "examples": { "default": { "value": "abcde12345fghij67890" } }
           }
         ],
         "requestBody": {
@@ -13858,6 +13870,17 @@
                 },
                 "required": ["client_secret"],
                 "type": "object"
+              },
+              "examples": {
+                "default": {
+                  "summary": "Create an authorization for an app",
+                  "value": {
+                    "client_secret": "3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f",
+                    "scopes": ["public_repo"],
+                    "note": "optional note",
+                    "note_url": "http://optional/note/url"
+                  }
+                }
               }
             }
           }
@@ -14966,9 +14989,9 @@
             "name": "client_id",
             "in": "path",
             "required": true,
-            "description": "The client ID of the GitHub app.",
+            "description": "The client ID of the OAuth app.",
             "schema": { "type": "string" },
-            "examples": { "default": { "value": "Iv1.8a61f9b3a7aba766" } }
+            "examples": { "default": { "value": "abcde12345fghij67890" } }
           },
           {
             "name": "fingerprint",
@@ -15007,6 +15030,17 @@
                 },
                 "required": ["client_secret"],
                 "type": "object"
+              },
+              "examples": {
+                "default": {
+                  "summary": "Create an authorization for an app and fingerprint",
+                  "value": {
+                    "client_secret": "3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f",
+                    "scopes": ["public_repo"],
+                    "note": "optional note",
+                    "note_url": "http://optional/note/url"
+                  }
+                }
               }
             }
           }
@@ -47563,7 +47597,7 @@
                   },
                   "members_allowed_repository_creation_type": {
                     "type": "string",
-                    "description": "Specifies which types of repositories non-admin organization members can create. `private` is only available to repositories that are part of an organization on GitHub Enterprise Cloud. \n**Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details.",
+                    "description": "Specifies which types of repositories non-admin organization members can create. \n**Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details.",
                     "enum": ["all", "private", "none"]
                   },
                   "members_can_create_pages": {
@@ -69626,6 +69660,7 @@
                   },
                   "exclude": {
                     "type": "array",
+                    "description": "Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `\"repositories\"`.",
                     "items": { "type": "string", "enum": ["repositories"] }
                   }
                 },
@@ -255692,7 +255727,7 @@
     "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": {
       "get": {
         "summary": "List requested reviewers for a pull request",
-        "description": "",
+        "description": "Lists the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/enterprise-server@3.4/rest/pulls/reviews#list-reviews-for-a-pull-request) operation.",
         "tags": ["pulls"],
         "operationId": "pulls/list-requested-reviewers",
         "externalDocs": {
@@ -308238,6 +308273,14 @@
                 },
                 "required": ["repositories"],
                 "type": "object"
+              },
+              "examples": {
+                "default": {
+                  "value": {
+                    "repositories": ["octocat/Hello-World"],
+                    "lock_repositories": true
+                  }
+                }
               }
             }
           }
@@ -343283,7 +343326,7 @@
     "/enterprises/{enterprise}/actions/cache/usage": {
       "get": {
         "summary": "Get GitHub Actions cache usage for an enterprise",
-        "description": "This endpoint does not exist ghes-3.4. It was added in ghes-3.5",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.4. It was added in 3.5",
         "operationId": "actions/get-actions-cache-usage-for-enterprise",
         "tags": ["actions"],
         "externalDocs": {
@@ -343297,7 +343340,7 @@
     "/enterprises/{enterprise}/actions/cache/usage-policy": {
       "get": {
         "summary": "Get GitHub Actions cache usage policy for an enterprise",
-        "description": "This endpoint does not exist ghes-3.4. It was added in ghes-3.5",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.4. It was added in 3.5",
         "tags": ["actions"],
         "operationId": "actions/get-actions-cache-usage-policy-for-enterprise",
         "externalDocs": {
@@ -343309,7 +343352,7 @@
       },
       "patch": {
         "summary": "Set GitHub Actions cache usage policy for an enterprise",
-        "description": "This endpoint does not exist ghes-3.4. It was added in ghes-3.5",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.4. It was added in 3.5",
         "tags": ["actions"],
         "operationId": "actions/set-actions-cache-usage-policy-for-enterprise",
         "externalDocs": {
@@ -343323,7 +343366,7 @@
     "/orgs/{org}/actions/cache/usage": {
       "get": {
         "summary": "Get GitHub Actions cache usage for an organization",
-        "description": "This endpoint does not exist ghes-3.4. It was added in ghes-3.5",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.4. It was added in 3.5",
         "tags": ["actions"],
         "operationId": "actions/get-actions-cache-usage-for-org",
         "externalDocs": {
@@ -343337,7 +343380,7 @@
     "/orgs/{org}/actions/cache/usage-by-repository": {
       "get": {
         "summary": "List repositories with GitHub Actions cache usage for an organization",
-        "description": "This endpoint does not exist ghes-3.4. It was added in ghes-3.5",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.4. It was added in 3.5",
         "tags": ["actions"],
         "operationId": "actions/get-actions-cache-usage-by-repo-for-org",
         "externalDocs": {
@@ -343351,7 +343394,7 @@
     "/orgs/{org}/actions/permissions/workflow": {
       "get": {
         "summary": "Get default workflow permissions for an organization",
-        "description": "This endpoint does not exist ghes-3.4. It was added in ghes-3.5",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.4. It was added in 3.5",
         "tags": ["actions"],
         "operationId": "actions/get-github-actions-default-workflow-permissions-organization",
         "externalDocs": {
@@ -343363,7 +343406,7 @@
       },
       "put": {
         "summary": "Set default workflow permissions for an organization",
-        "description": "This endpoint does not exist ghes-3.4. It was added in ghes-3.5",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.4. It was added in 3.5",
         "tags": ["actions"],
         "operationId": "actions/set-github-actions-default-workflow-permissions-organization",
         "externalDocs": {
@@ -343377,7 +343420,7 @@
     "/orgs/{org}/code-scanning/alerts": {
       "get": {
         "summary": "List code scanning alerts for an organization",
-        "description": "This endpoint does not exist ghes-3.4. It was added in ghes-3.5",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.4. It was added in 3.5",
         "tags": ["code-scanning"],
         "operationId": "code-scanning/list-alerts-for-org",
         "externalDocs": {
@@ -343391,7 +343434,7 @@
     "/repos/{owner}/{repo}/actions/cache/usage": {
       "get": {
         "summary": "Get GitHub Actions cache usage for a repository",
-        "description": "This endpoint does not exist ghes-3.4. It was added in ghes-3.5",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.4. It was added in 3.5",
         "tags": ["actions"],
         "operationId": "actions/get-actions-cache-usage",
         "externalDocs": {
@@ -343405,7 +343448,7 @@
     "/repos/{owner}/{repo}/actions/cache/usage-policy": {
       "get": {
         "summary": "Get GitHub Actions cache usage policy for a repository",
-        "description": "This endpoint does not exist ghes-3.4. It was added in ghes-3.5",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.4. It was added in 3.5",
         "tags": ["actions"],
         "operationId": "actions/get-actions-cache-usage-policy",
         "externalDocs": {
@@ -343417,7 +343460,7 @@
       },
       "patch": {
         "summary": "Set GitHub Actions cache usage policy for a repository",
-        "description": "This endpoint does not exist ghes-3.4. It was added in ghes-3.5",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.4. It was added in 3.5",
         "tags": ["actions"],
         "operationId": "actions/set-actions-cache-usage-policy",
         "externalDocs": {
@@ -343431,7 +343474,7 @@
     "/repos/{owner}/{repo}/actions/jobs/{job_id}/rerun": {
       "post": {
         "summary": "Re-run a job from a workflow run",
-        "description": "This endpoint does not exist ghes-3.4. It was added in ghes-3.5",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.4. It was added in 3.5",
         "tags": ["actions"],
         "operationId": "actions/re-run-job-for-workflow-run",
         "externalDocs": {
@@ -343445,7 +343488,7 @@
     "/repos/{owner}/{repo}/actions/permissions/access": {
       "get": {
         "summary": "Get the level of access for workflows outside of the repository",
-        "description": "This endpoint does not exist ghes-3.4. It was added in ghes-3.5",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.4. It was added in 3.5",
         "tags": ["actions"],
         "operationId": "actions/get-workflow-access-to-repository",
         "externalDocs": {
@@ -343457,7 +343500,7 @@
       },
       "put": {
         "summary": "Set the level of access for workflows outside of the repository",
-        "description": "This endpoint does not exist ghes-3.4. It was added in ghes-3.5",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.4. It was added in 3.5",
         "tags": ["actions"],
         "operationId": "actions/set-workflow-access-to-repository",
         "externalDocs": {
@@ -343471,7 +343514,7 @@
     "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}": {
       "get": {
         "summary": "Get a workflow run attempt",
-        "description": "This endpoint does not exist ghes-3.4. It was added in ghes-3.5",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.4. It was added in 3.5",
         "tags": ["actions"],
         "operationId": "actions/get-workflow-run-attempt",
         "externalDocs": {
@@ -343485,7 +343528,7 @@
     "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs": {
       "get": {
         "summary": "List jobs for a workflow run attempt",
-        "description": "This endpoint does not exist ghes-3.4. It was added in ghes-3.5",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.4. It was added in 3.5",
         "tags": ["actions"],
         "operationId": "actions/list-jobs-for-workflow-run-attempt",
         "externalDocs": {
@@ -343499,7 +343542,7 @@
     "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs": {
       "get": {
         "summary": "Download workflow run attempt logs",
-        "description": "This endpoint does not exist ghes-3.4. It was added in ghes-3.5",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.4. It was added in 3.5",
         "tags": ["actions"],
         "operationId": "actions/download-workflow-run-attempt-logs",
         "externalDocs": {
@@ -343513,7 +343556,7 @@
     "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun-failed-jobs": {
       "post": {
         "summary": "Re-run failed jobs from a workflow run",
-        "description": "This endpoint does not exist ghes-3.4. It was added in ghes-3.5",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.4. It was added in 3.5",
         "tags": ["actions"],
         "operationId": "actions/re-run-workflow-failed-jobs",
         "externalDocs": {
@@ -343527,7 +343570,7 @@
     "/repos/{owner}/{repo}/codeowners/errors": {
       "get": {
         "summary": "List CODEOWNERS errors",
-        "description": "This endpoint does not exist ghes-3.4. It was added in ghes-3.5",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.4. It was added in 3.5",
         "tags": ["repos"],
         "operationId": "repos/codeowners-errors",
         "externalDocs": {
@@ -343541,7 +343584,7 @@
     "/repos/{owner}/{repo}/tags/protection": {
       "get": {
         "summary": "List tag protection states for a repository",
-        "description": "This endpoint does not exist ghes-3.4. It was added in ghes-3.5",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.4. It was added in 3.5",
         "tags": ["repos"],
         "operationId": "repos/list-tag-protection",
         "externalDocs": {
@@ -343553,7 +343596,7 @@
       },
       "post": {
         "summary": "Create a tag protection state for a repository",
-        "description": "This endpoint does not exist ghes-3.4. It was added in ghes-3.5",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.4. It was added in 3.5",
         "tags": ["repos"],
         "operationId": "repos/create-tag-protection",
         "externalDocs": {
@@ -343567,7 +343610,7 @@
     "/repos/{owner}/{repo}/tags/protection/{tag_protection_id}": {
       "delete": {
         "summary": "Delete a tag protection state for a repository",
-        "description": "This endpoint does not exist ghes-3.4. It was added in ghes-3.5",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.4. It was added in 3.5",
         "tags": ["repos"],
         "operationId": "repos/delete-tag-protection",
         "externalDocs": {