@octokit/openapi 6.6.1 → 6.7.0

package/generated/ghes-3.2-diff-to-ghes-3.3.deref.json

@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "version": "6.6.1",
+    "version": "6.7.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": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },

package/generated/ghes-3.2-diff-to-ghes-3.3.json

@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "version": "6.6.1",
+    "version": "6.7.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": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },

package/generated/ghes-3.2.deref.json

@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "version": "6.6.1",
+    "version": "6.7.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": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
@@ -14597,6 +14597,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"
+                  }
+                }
               }
             }
           }
@@ -15230,9 +15242,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": {
@@ -15269,6 +15281,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"
+                  }
+                }
               }
             }
           }
@@ -16387,9 +16410,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",
@@ -16428,6 +16451,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"
+                  }
+                }
               }
             }
           }
@@ -242729,7 +242763,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.2/rest/pulls/reviews#list-reviews-for-a-pull-request) operation.",
         "tags": ["pulls"],
         "operationId": "pulls/list-requested-reviewers",
         "externalDocs": {

package/generated/ghes-3.2.json

@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "version": "6.6.1",
+    "version": "6.7.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": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
@@ -3245,6 +3245,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"
+                  }
+                }
               }
             }
           }
@@ -3295,7 +3307,7 @@
           "description": "API method documentation",
           "url": "https://docs.github.com/enterprise-server@3.2/rest/reference/oauth-authorizations#get-or-create-an-authorization-for-a-specific-app"
         },
-        "parameters": [{ "$ref": "#/components/parameters/client-id" }],
+        "parameters": [{ "$ref": "#/components/parameters/oauth-client-id" }],
         "requestBody": {
           "required": true,
           "content": {
@@ -3330,6 +3342,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"
+                  }
+                }
               }
             }
           }
@@ -3399,7 +3422,7 @@
           "url": "https://docs.github.com/enterprise-server@3.2/rest/reference/oauth-authorizations#get-or-create-an-authorization-for-a-specific-app-and-fingerprint"
         },
         "parameters": [
-          { "$ref": "#/components/parameters/client-id" },
+          { "$ref": "#/components/parameters/oauth-client-id" },
           {
             "name": "fingerprint",
             "in": "path",
@@ -3437,6 +3460,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"
+                  }
+                }
               }
             }
           }
@@ -28458,7 +28492,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.2/rest/pulls/reviews#list-reviews-for-a-pull-request) operation.",
         "tags": ["pulls"],
         "operationId": "pulls/list-requested-reviewers",
         "externalDocs": {
@@ -72880,6 +72914,14 @@
         "required": true,
         "schema": { "type": "string" }
       },
+      "oauth-client-id": {
+        "name": "client_id",
+        "in": "path",
+        "required": true,
+        "description": "The client ID of the OAuth app.",
+        "schema": { "type": "string" },
+        "examples": { "default": { "value": "abcde12345fghij67890" } }
+      },
       "authorization-id": {
         "name": "authorization_id",
         "description": "The unique identifier of the authorization.",

package/generated/ghes-3.3-diff-to-ghes-3.4.deref.json

@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "version": "6.6.1",
+    "version": "6.7.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": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
@@ -8549,6 +8549,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"
+                  }
+                }
               }
             }
           }
@@ -9182,9 +9194,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": {
@@ -9221,6 +9233,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"
+                  }
+                }
               }
             }
           }
@@ -10339,9 +10362,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",
@@ -10380,6 +10403,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"
+                  }
+                }
               }
             }
           }

package/generated/ghes-3.3-diff-to-ghes-3.4.json

@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "version": "6.6.1",
+    "version": "6.7.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": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
@@ -842,6 +842,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"
+                  }
+                }
               }
             }
           }
@@ -892,7 +904,7 @@
           "description": "API method documentation",
           "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/oauth-authorizations#get-or-create-an-authorization-for-a-specific-app"
         },
-        "parameters": [{ "$ref": "#/components/parameters/client-id" }],
+        "parameters": [{ "$ref": "#/components/parameters/oauth-client-id" }],
         "requestBody": {
           "required": true,
           "content": {
@@ -927,6 +939,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"
+                  }
+                }
               }
             }
           }
@@ -996,7 +1019,7 @@
           "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/oauth-authorizations#get-or-create-an-authorization-for-a-specific-app-and-fingerprint"
         },
         "parameters": [
-          { "$ref": "#/components/parameters/client-id" },
+          { "$ref": "#/components/parameters/oauth-client-id" },
           {
             "name": "fingerprint",
             "in": "path",
@@ -1034,6 +1057,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"
+                  }
+                }
               }
             }
           }
@@ -3349,6 +3383,14 @@
         "required": true,
         "schema": { "type": "string" }
       },
+      "oauth-client-id": {
+        "name": "client_id",
+        "in": "path",
+        "required": true,
+        "description": "The client ID of the OAuth app.",
+        "schema": { "type": "string" },
+        "examples": { "default": { "value": "abcde12345fghij67890" } }
+      },
       "authorization-id": {
         "name": "authorization_id",
         "description": "The unique identifier of the authorization.",

package/generated/ghes-3.3.deref.json

@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "version": "6.6.1",
+    "version": "6.7.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": { "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"
+                  }
+                }
               }
             }
           }
@@ -244164,7 +244198,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.3/rest/pulls/reviews#list-reviews-for-a-pull-request) operation.",
         "tags": ["pulls"],
         "operationId": "pulls/list-requested-reviewers",
         "externalDocs": {

package/generated/ghes-3.3.json

@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "version": "6.6.1",
+    "version": "6.7.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": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
@@ -3076,6 +3076,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"
+                  }
+                }
               }
             }
           }
@@ -3126,7 +3138,7 @@
           "description": "API method documentation",
           "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/oauth-authorizations#get-or-create-an-authorization-for-a-specific-app"
         },
-        "parameters": [{ "$ref": "#/components/parameters/client-id" }],
+        "parameters": [{ "$ref": "#/components/parameters/oauth-client-id" }],
         "requestBody": {
           "required": true,
           "content": {
@@ -3161,6 +3173,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"
+                  }
+                }
               }
             }
           }
@@ -3230,7 +3253,7 @@
           "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/oauth-authorizations#get-or-create-an-authorization-for-a-specific-app-and-fingerprint"
         },
         "parameters": [
-          { "$ref": "#/components/parameters/client-id" },
+          { "$ref": "#/components/parameters/oauth-client-id" },
           {
             "name": "fingerprint",
             "in": "path",
@@ -3268,6 +3291,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"
+                  }
+                }
               }
             }
           }
@@ -28025,7 +28059,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.3/rest/pulls/reviews#list-reviews-for-a-pull-request) operation.",
         "tags": ["pulls"],
         "operationId": "pulls/list-requested-reviewers",
         "externalDocs": {
@@ -73315,6 +73349,14 @@
         "required": true,
         "schema": { "type": "string" }
       },
+      "oauth-client-id": {
+        "name": "client_id",
+        "in": "path",
+        "required": true,
+        "description": "The client ID of the OAuth app.",
+        "schema": { "type": "string" },
+        "examples": { "default": { "value": "abcde12345fghij67890" } }
+      },
       "authorization-id": {
         "name": "authorization_id",
         "description": "The unique identifier of the authorization.",

package/generated/ghes-3.4-diff-to-ghes-3.5.deref.json

@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "version": "6.6.1",
+    "version": "6.7.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": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },

package/generated/ghes-3.4-diff-to-ghes-3.5.json

@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "version": "6.6.1",
+    "version": "6.7.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": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },