@octokit/openapi 6.5.0 → 6.6.2

package/generated/ghes-3.3.deref.json

@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "version": "6.5.0",
+    "version": "6.6.2",
     "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" },
@@ -14458,6 +14458,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"
+                  }
+                }
               }
             }
           }
@@ -15091,9 +15103,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": {
@@ -15130,6 +15142,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"
+                  }
+                }
               }
             }
           }
@@ -16248,9 +16271,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",
@@ -16289,6 +16312,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"
+                  }
+                }
               }
             }
           }
@@ -47108,7 +47142,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": {
@@ -327812,7 +327846,7 @@
     "/enterprises/{enterprise}/actions/runners/{runner_id}/labels": {
       "get": {
         "summary": "List labels for a self-hosted runner for an enterprise",
-        "description": "This endpoint does not exist ghes-3.3. It was added in ghes-3.4",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.3. It was added in 3.4",
         "tags": ["enterprise-admin"],
         "operationId": "enterprise-admin/list-labels-for-self-hosted-runner-for-enterprise",
         "externalDocs": {
@@ -327824,7 +327858,7 @@
       },
       "put": {
         "summary": "Set custom labels for a self-hosted runner for an enterprise",
-        "description": "This endpoint does not exist ghes-3.3. It was added in ghes-3.4",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.3. It was added in 3.4",
         "tags": ["enterprise-admin"],
         "operationId": "enterprise-admin/set-custom-labels-for-self-hosted-runner-for-enterprise",
         "externalDocs": {
@@ -327836,7 +327870,7 @@
       },
       "post": {
         "summary": "Add custom labels to a self-hosted runner for an enterprise",
-        "description": "This endpoint does not exist ghes-3.3. It was added in ghes-3.4",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.3. It was added in 3.4",
         "tags": ["enterprise-admin"],
         "operationId": "enterprise-admin/add-custom-labels-to-self-hosted-runner-for-enterprise",
         "externalDocs": {
@@ -327848,7 +327882,7 @@
       },
       "delete": {
         "summary": "Remove all custom labels from a self-hosted runner for an enterprise",
-        "description": "This endpoint does not exist ghes-3.3. It was added in ghes-3.4",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.3. It was added in 3.4",
         "tags": ["enterprise-admin"],
         "operationId": "enterprise-admin/remove-all-custom-labels-from-self-hosted-runner-for-enterprise",
         "externalDocs": {
@@ -327862,7 +327896,7 @@
     "/enterprises/{enterprise}/actions/runners/{runner_id}/labels/{name}": {
       "delete": {
         "summary": "Remove a custom label from a self-hosted runner for an enterprise",
-        "description": "This endpoint does not exist ghes-3.3. It was added in ghes-3.4",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.3. It was added in 3.4",
         "tags": ["enterprise-admin"],
         "operationId": "enterprise-admin/remove-custom-label-from-self-hosted-runner-for-enterprise",
         "externalDocs": {
@@ -327876,7 +327910,7 @@
     "/enterprises/{enterprise}/secret-scanning/alerts": {
       "get": {
         "summary": "List secret scanning alerts for an enterprise",
-        "description": "This endpoint does not exist ghes-3.3. It was added in ghes-3.4",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.3. It was added in 3.4",
         "tags": ["secret-scanning"],
         "operationId": "secret-scanning/list-alerts-for-enterprise",
         "externalDocs": {
@@ -327890,7 +327924,7 @@
     "/enterprises/{enterprise}/settings/billing/advanced-security": {
       "get": {
         "summary": "Get GitHub Advanced Security active committers for an enterprise",
-        "description": "This endpoint does not exist ghes-3.3. It was added in ghes-3.4",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.3. It was added in 3.4",
         "tags": ["billing"],
         "operationId": "billing/get-github-advanced-security-billing-ghe",
         "externalDocs": {
@@ -327904,7 +327938,7 @@
     "/organizations/{organization_id}/custom_roles": {
       "get": {
         "summary": "List custom repository roles in an organization",
-        "description": "This endpoint does not exist ghes-3.3. It was added in ghes-3.4",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.3. It was added in 3.4",
         "tags": ["orgs"],
         "operationId": "orgs/list-custom-roles",
         "externalDocs": {
@@ -327918,7 +327952,7 @@
     "/orgs/{org}/actions/runners/{runner_id}/labels": {
       "get": {
         "summary": "List labels for a self-hosted runner for an organization",
-        "description": "This endpoint does not exist ghes-3.3. It was added in ghes-3.4",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.3. It was added in 3.4",
         "tags": ["actions"],
         "operationId": "actions/list-labels-for-self-hosted-runner-for-org",
         "externalDocs": {
@@ -327930,7 +327964,7 @@
       },
       "put": {
         "summary": "Set custom labels for a self-hosted runner for an organization",
-        "description": "This endpoint does not exist ghes-3.3. It was added in ghes-3.4",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.3. It was added in 3.4",
         "tags": ["actions"],
         "operationId": "actions/set-custom-labels-for-self-hosted-runner-for-org",
         "externalDocs": {
@@ -327942,7 +327976,7 @@
       },
       "post": {
         "summary": "Add custom labels to a self-hosted runner for an organization",
-        "description": "This endpoint does not exist ghes-3.3. It was added in ghes-3.4",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.3. It was added in 3.4",
         "tags": ["actions"],
         "operationId": "actions/add-custom-labels-to-self-hosted-runner-for-org",
         "externalDocs": {
@@ -327954,7 +327988,7 @@
       },
       "delete": {
         "summary": "Remove all custom labels from a self-hosted runner for an organization",
-        "description": "This endpoint does not exist ghes-3.3. It was added in ghes-3.4",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.3. It was added in 3.4",
         "tags": ["actions"],
         "operationId": "actions/remove-all-custom-labels-from-self-hosted-runner-for-org",
         "externalDocs": {
@@ -327968,7 +328002,7 @@
     "/orgs/{org}/actions/runners/{runner_id}/labels/{name}": {
       "delete": {
         "summary": "Remove a custom label from a self-hosted runner for an organization",
-        "description": "This endpoint does not exist ghes-3.3. It was added in ghes-3.4",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.3. It was added in 3.4",
         "tags": ["actions"],
         "operationId": "actions/remove-custom-label-from-self-hosted-runner-for-org",
         "externalDocs": {
@@ -327982,7 +328016,7 @@
     "/orgs/{org}/dependabot/secrets": {
       "get": {
         "summary": "List organization secrets",
-        "description": "This endpoint does not exist ghes-3.3. It was added in ghes-3.4",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.3. It was added in 3.4",
         "tags": ["dependabot"],
         "operationId": "dependabot/list-org-secrets",
         "externalDocs": {
@@ -327996,7 +328030,7 @@
     "/orgs/{org}/dependabot/secrets/public-key": {
       "get": {
         "summary": "Get an organization public key",
-        "description": "This endpoint does not exist ghes-3.3. It was added in ghes-3.4",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.3. It was added in 3.4",
         "tags": ["dependabot"],
         "operationId": "dependabot/get-org-public-key",
         "externalDocs": {
@@ -328010,7 +328044,7 @@
     "/orgs/{org}/dependabot/secrets/{secret_name}": {
       "get": {
         "summary": "Get an organization secret",
-        "description": "This endpoint does not exist ghes-3.3. It was added in ghes-3.4",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.3. It was added in 3.4",
         "tags": ["dependabot"],
         "operationId": "dependabot/get-org-secret",
         "externalDocs": {
@@ -328022,7 +328056,7 @@
       },
       "put": {
         "summary": "Create or update an organization secret",
-        "description": "This endpoint does not exist ghes-3.3. It was added in ghes-3.4",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.3. It was added in 3.4",
         "tags": ["dependabot"],
         "operationId": "dependabot/create-or-update-org-secret",
         "externalDocs": {
@@ -328034,7 +328068,7 @@
       },
       "delete": {
         "summary": "Delete an organization secret",
-        "description": "This endpoint does not exist ghes-3.3. It was added in ghes-3.4",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.3. It was added in 3.4",
         "tags": ["dependabot"],
         "operationId": "dependabot/delete-org-secret",
         "externalDocs": {
@@ -328048,7 +328082,7 @@
     "/orgs/{org}/dependabot/secrets/{secret_name}/repositories": {
       "get": {
         "summary": "List selected repositories for an organization secret",
-        "description": "This endpoint does not exist ghes-3.3. It was added in ghes-3.4",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.3. It was added in 3.4",
         "tags": ["dependabot"],
         "operationId": "dependabot/list-selected-repos-for-org-secret",
         "externalDocs": {
@@ -328060,7 +328094,7 @@
       },
       "put": {
         "summary": "Set selected repositories for an organization secret",
-        "description": "This endpoint does not exist ghes-3.3. It was added in ghes-3.4",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.3. It was added in 3.4",
         "tags": ["dependabot"],
         "operationId": "dependabot/set-selected-repos-for-org-secret",
         "externalDocs": {
@@ -328074,7 +328108,7 @@
     "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}": {
       "put": {
         "summary": "Add selected repository to an organization secret",
-        "description": "This endpoint does not exist ghes-3.3. It was added in ghes-3.4",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.3. It was added in 3.4",
         "tags": ["dependabot"],
         "operationId": "dependabot/add-selected-repo-to-org-secret",
         "externalDocs": {
@@ -328086,7 +328120,7 @@
       },
       "delete": {
         "summary": "Remove selected repository from an organization secret",
-        "description": "This endpoint does not exist ghes-3.3. It was added in ghes-3.4",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.3. It was added in 3.4",
         "tags": ["dependabot"],
         "operationId": "dependabot/remove-selected-repo-from-org-secret",
         "externalDocs": {
@@ -328100,7 +328134,7 @@
     "/orgs/{org}/migrations": {
       "get": {
         "summary": "List organization migrations",
-        "description": "This endpoint does not exist ghes-3.3. It was added in ghes-3.4",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.3. It was added in 3.4",
         "tags": ["migrations"],
         "operationId": "migrations/list-for-org",
         "externalDocs": {
@@ -328112,7 +328146,7 @@
       },
       "post": {
         "summary": "Start an organization migration",
-        "description": "This endpoint does not exist ghes-3.3. It was added in ghes-3.4",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.3. It was added in 3.4",
         "tags": ["migrations"],
         "operationId": "migrations/start-for-org",
         "externalDocs": {
@@ -328126,7 +328160,7 @@
     "/orgs/{org}/migrations/{migration_id}": {
       "get": {
         "summary": "Get an organization migration status",
-        "description": "This endpoint does not exist ghes-3.3. It was added in ghes-3.4",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.3. It was added in 3.4",
         "tags": ["migrations"],
         "operationId": "migrations/get-status-for-org",
         "externalDocs": {
@@ -328140,7 +328174,7 @@
     "/orgs/{org}/settings/billing/advanced-security": {
       "get": {
         "summary": "Get GitHub Advanced Security active committers for an organization",
-        "description": "This endpoint does not exist ghes-3.3. It was added in ghes-3.4",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.3. It was added in 3.4",
         "tags": ["billing"],
         "operationId": "billing/get-github-advanced-security-billing-org",
         "externalDocs": {
@@ -328154,7 +328188,7 @@
     "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels": {
       "get": {
         "summary": "List labels for a self-hosted runner for a repository",
-        "description": "This endpoint does not exist ghes-3.3. It was added in ghes-3.4",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.3. It was added in 3.4",
         "tags": ["actions"],
         "operationId": "actions/list-labels-for-self-hosted-runner-for-repo",
         "externalDocs": {
@@ -328166,7 +328200,7 @@
       },
       "put": {
         "summary": "Set custom labels for a self-hosted runner for a repository",
-        "description": "This endpoint does not exist ghes-3.3. It was added in ghes-3.4",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.3. It was added in 3.4",
         "tags": ["actions"],
         "operationId": "actions/set-custom-labels-for-self-hosted-runner-for-repo",
         "externalDocs": {
@@ -328178,7 +328212,7 @@
       },
       "post": {
         "summary": "Add custom labels to a self-hosted runner for a repository",
-        "description": "This endpoint does not exist ghes-3.3. It was added in ghes-3.4",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.3. It was added in 3.4",
         "tags": ["actions"],
         "operationId": "actions/add-custom-labels-to-self-hosted-runner-for-repo",
         "externalDocs": {
@@ -328190,7 +328224,7 @@
       },
       "delete": {
         "summary": "Remove all custom labels from a self-hosted runner for a repository",
-        "description": "This endpoint does not exist ghes-3.3. It was added in ghes-3.4",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.3. It was added in 3.4",
         "tags": ["actions"],
         "operationId": "actions/remove-all-custom-labels-from-self-hosted-runner-for-repo",
         "externalDocs": {
@@ -328204,7 +328238,7 @@
     "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}": {
       "delete": {
         "summary": "Remove a custom label from a self-hosted runner for a repository",
-        "description": "This endpoint does not exist ghes-3.3. It was added in ghes-3.4",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.3. It was added in 3.4",
         "tags": ["actions"],
         "operationId": "actions/remove-custom-label-from-self-hosted-runner-for-repo",
         "externalDocs": {
@@ -328218,7 +328252,7 @@
     "/repos/{owner}/{repo}/dependabot/secrets": {
       "get": {
         "summary": "List repository secrets",
-        "description": "This endpoint does not exist ghes-3.3. It was added in ghes-3.4",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.3. It was added in 3.4",
         "tags": ["dependabot"],
         "operationId": "dependabot/list-repo-secrets",
         "externalDocs": {
@@ -328232,7 +328266,7 @@
     "/repos/{owner}/{repo}/dependabot/secrets/public-key": {
       "get": {
         "summary": "Get a repository public key",
-        "description": "This endpoint does not exist ghes-3.3. It was added in ghes-3.4",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.3. It was added in 3.4",
         "tags": ["dependabot"],
         "operationId": "dependabot/get-repo-public-key",
         "externalDocs": {
@@ -328246,7 +328280,7 @@
     "/repos/{owner}/{repo}/dependabot/secrets/{secret_name}": {
       "get": {
         "summary": "Get a repository secret",
-        "description": "This endpoint does not exist ghes-3.3. It was added in ghes-3.4",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.3. It was added in 3.4",
         "tags": ["dependabot"],
         "operationId": "dependabot/get-repo-secret",
         "externalDocs": {
@@ -328258,7 +328292,7 @@
       },
       "put": {
         "summary": "Create or update a repository secret",
-        "description": "This endpoint does not exist ghes-3.3. It was added in ghes-3.4",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.3. It was added in 3.4",
         "tags": ["dependabot"],
         "operationId": "dependabot/create-or-update-repo-secret",
         "externalDocs": {
@@ -328270,7 +328304,7 @@
       },
       "delete": {
         "summary": "Delete a repository secret",
-        "description": "This endpoint does not exist ghes-3.3. It was added in ghes-3.4",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.3. It was added in 3.4",
         "tags": ["dependabot"],
         "operationId": "dependabot/delete-repo-secret",
         "externalDocs": {
@@ -328284,7 +328318,7 @@
     "/repos/{owner}/{repo}/replicas/caches": {
       "get": {
         "summary": "List repository cache replication status",
-        "description": "This endpoint does not exist ghes-3.3. It was added in ghes-3.4",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.3. It was added in 3.4",
         "tags": ["repos"],
         "operationId": "repos/list-cache-info",
         "externalDocs": {
@@ -328298,7 +328332,7 @@
     "/user/migrations": {
       "get": {
         "summary": "List user migrations",
-        "description": "This endpoint does not exist ghes-3.3. It was added in ghes-3.4",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.3. It was added in 3.4",
         "tags": ["migrations"],
         "operationId": "migrations/list-for-authenticated-user",
         "externalDocs": {
@@ -328310,7 +328344,7 @@
       },
       "post": {
         "summary": "Start a user migration",
-        "description": "This endpoint does not exist ghes-3.3. It was added in ghes-3.4",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.3. It was added in 3.4",
         "tags": ["migrations"],
         "operationId": "migrations/start-for-authenticated-user",
         "externalDocs": {
@@ -328324,7 +328358,7 @@
     "/user/migrations/{migration_id}/archive": {
       "get": {
         "summary": "Download a user migration archive",
-        "description": "This endpoint does not exist ghes-3.3. It was added in ghes-3.4",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.3. It was added in 3.4",
         "tags": ["migrations"],
         "operationId": "migrations/get-archive-for-authenticated-user",
         "externalDocs": {
@@ -328338,7 +328372,7 @@
     "/user/migrations/{migration_id}/repositories": {
       "get": {
         "summary": "List repositories for a user migration",
-        "description": "This endpoint does not exist ghes-3.3. It was added in ghes-3.4",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.3. It was added in 3.4",
         "tags": ["migrations"],
         "operationId": "migrations/list-repos-for-authenticated-user",
         "externalDocs": {