Update OpenAPI Description (#34376)

lib/rest/static/decorated/api.github.com.2022-11-28.json

@@ -336973,6 +336973,7 @@
                     },
                     "repositories": {
                       "type": "array",
+                      "description": "The repositories included in the migration. Only returned for export migrations.",
                       "items": {
                         "title": "Repository",
                         "description": "A repository on GitHub.",
@@ -338500,7 +338501,7 @@
           }
         ],
         "previews": [],
-        "descriptionHTML": "<p>Lists the most recent migrations.</p>",
+        "descriptionHTML": "<p>Lists the most recent migrations, including both exports (which can be started through the REST API) and imports (which cannot be started using the REST API).</p>\n<p>A list of <code>repositories</code> is only returned for export migrations.</p>",
         "statusCodes": [
           {
             "httpStatusCode": "200",
@@ -338987,6 +338988,7 @@
                   },
                   "repositories": {
                     "type": "array",
+                    "description": "The repositories included in the migration. Only returned for export migrations.",
                     "items": {
                       "title": "Repository",
                       "description": "A repository on GitHub.",
@@ -340966,6 +340968,7 @@
                   },
                   "repositories": {
                     "type": "array",
+                    "description": "The repositories included in the migration. Only returned for export migrations.",
                     "items": {
                       "title": "Repository",
                       "description": "A repository on GitHub.",
@@ -345914,6 +345917,7 @@
                     },
                     "repositories": {
                       "type": "array",
+                      "description": "The repositories included in the migration. Only returned for export migrations.",
                       "items": {
                         "title": "Repository",
                         "description": "A repository on GitHub.",
@@ -347921,6 +347925,7 @@
                   },
                   "repositories": {
                     "type": "array",
+                    "description": "The repositories included in the migration. Only returned for export migrations.",
                     "items": {
                       "title": "Repository",
                       "description": "A repository on GitHub.",
@@ -349893,6 +349898,7 @@
                   },
                   "repositories": {
                     "type": "array",
+                    "description": "The repositories included in the migration. Only returned for export migrations.",
                     "items": {
                       "title": "Repository",
                       "description": "A repository on GitHub.",
@@ -434871,7 +434877,7 @@
               "contentType": "application/octet-stream",
               "description": "Example",
               "acceptHeader": "application/vnd.github.v3+json",
-              "bodyParameters": "@release-asset.gz",
+              "bodyParameters": "@example.zip",
               "parameters": {
                 "owner": "OWNER",
                 "repo": "REPO",
@@ -435162,7 +435168,7 @@
           }
         ],
         "previews": [],
-        "descriptionHTML": "<p>This endpoint makes use of <a href=\"https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia\">a Hypermedia relation</a> to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the <code>upload_url</code> returned in\nthe response of the <a href=\"https://docs.github.com/rest/releases/releases#create-a-release\">Create a release endpoint</a> to upload a release asset.</p>\n<p>You need to use an HTTP client which supports <a href=\"http://en.wikipedia.org/wiki/Server_Name_Indication\">SNI</a> to make calls to this endpoint.</p>\n<p>Most libraries will set the required <code>Content-Length</code> header automatically. Use the required <code>Content-Type</code> header to provide the media type of the asset. For a list of media types, see <a href=\"https://www.iana.org/assignments/media-types/media-types.xhtml\">Media Types</a>. For example: </p>\n<p><code>application/zip</code></p>\n<p>GitHub expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.</p>\n<p>When an upstream failure occurs, you will receive a <code>502 Bad Gateway</code> status. This may leave an empty asset with a state of <code>starter</code>. It can be safely deleted.</p>\n<p><strong>Notes:</strong></p>\n<ul>\n<li>GitHub renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"<a href=\"https://docs.github.com/rest/reference/repos#list-assets-for-a-release\">List assets for a release</a>\"\nendpoint lists the renamed filenames. For more information and help, contact <a href=\"https://support.github.com/contact?tags=dotcom-rest-api\">GitHub Support</a>.</li>\n<li>If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.</li>\n</ul>",
+        "descriptionHTML": "<p>This endpoint makes use of <a href=\"https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia\">a Hypermedia relation</a> to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the <code>upload_url</code> returned in\nthe response of the <a href=\"https://docs.github.com/rest/releases/releases#create-a-release\">Create a release endpoint</a> to upload a release asset.</p>\n<p>You need to use an HTTP client which supports <a href=\"http://en.wikipedia.org/wiki/Server_Name_Indication\">SNI</a> to make calls to this endpoint.</p>\n<p>Most libraries will set the required <code>Content-Length</code> header automatically. Use the required <code>Content-Type</code> header to provide the media type of the asset. For a list of media types, see <a href=\"https://www.iana.org/assignments/media-types/media-types.xhtml\">Media Types</a>. For example: </p>\n<p><code>application/zip</code></p>\n<p>GitHub expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.</p>\n<p>When an upstream failure occurs, you will receive a <code>502 Bad Gateway</code> status. This may leave an empty asset with a state of <code>starter</code>. It can be safely deleted.</p>\n<p><strong>Notes:</strong></p>\n<ul>\n<li>GitHub renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"<a href=\"https://docs.github.com/rest/reference/repos#list-assets-for-a-release\">List assets for a release</a>\"\nendpoint lists the renamed filenames. For more information and help, contact <a href=\"https://support.github.com/contact?tags=dotcom-rest-api\">GitHub Support</a>.</li>\n<li>To find the <code>release_id</code> query the <a href=\"https://docs.github.com/rest/releases/releases#get-the-latest-release\"><code>GET /repos/{owner}/{repo}/releases/latest</code> endpoint</a>. </li>\n<li>If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.</li>\n</ul>",
         "statusCodes": [
           {
             "httpStatusCode": "201",
@@ -436344,7 +436350,7 @@
             "type": "boolean",
             "name": "delete_branch_on_merge",
             "in": "body",
-            "description": "<p>Either <code>true</code> to allow automatically deleting head branches when pull requests are merged, or <code>false</code> to prevent automatic deletion.</p>",
+            "description": "<p>Either <code>true</code> to allow automatically deleting head branches when pull requests are merged, or <code>false</code> to prevent automatic deletion. <strong>The authenticated user must be an organization owner to set this property to <code>true</code>.</strong></p>",
             "default": false
           },
           {

lib/rest/static/decorated/ghec.2022-11-28.json

@@ -350143,6 +350143,7 @@
                     },
                     "repositories": {
                       "type": "array",
+                      "description": "The repositories included in the migration. Only returned for export migrations.",
                       "items": {
                         "title": "Repository",
                         "description": "A repository on GitHub.",
@@ -351670,7 +351671,7 @@
           }
         ],
         "previews": [],
-        "descriptionHTML": "<p>Lists the most recent migrations.</p>",
+        "descriptionHTML": "<p>Lists the most recent migrations, including both exports (which can be started through the REST API) and imports (which cannot be started using the REST API).</p>\n<p>A list of <code>repositories</code> is only returned for export migrations.</p>",
         "statusCodes": [
           {
             "httpStatusCode": "200",
@@ -352157,6 +352158,7 @@
                   },
                   "repositories": {
                     "type": "array",
+                    "description": "The repositories included in the migration. Only returned for export migrations.",
                     "items": {
                       "title": "Repository",
                       "description": "A repository on GitHub.",
@@ -354136,6 +354138,7 @@
                   },
                   "repositories": {
                     "type": "array",
+                    "description": "The repositories included in the migration. Only returned for export migrations.",
                     "items": {
                       "title": "Repository",
                       "description": "A repository on GitHub.",
@@ -359084,6 +359087,7 @@
                     },
                     "repositories": {
                       "type": "array",
+                      "description": "The repositories included in the migration. Only returned for export migrations.",
                       "items": {
                         "title": "Repository",
                         "description": "A repository on GitHub.",
@@ -361091,6 +361095,7 @@
                   },
                   "repositories": {
                     "type": "array",
+                    "description": "The repositories included in the migration. Only returned for export migrations.",
                     "items": {
                       "title": "Repository",
                       "description": "A repository on GitHub.",
@@ -363063,6 +363068,7 @@
                   },
                   "repositories": {
                     "type": "array",
+                    "description": "The repositories included in the migration. Only returned for export migrations.",
                     "items": {
                       "title": "Repository",
                       "description": "A repository on GitHub.",
@@ -450105,7 +450111,7 @@
               "contentType": "application/octet-stream",
               "description": "Example",
               "acceptHeader": "application/vnd.github.v3+json",
-              "bodyParameters": "@release-asset.gz",
+              "bodyParameters": "@example.zip",
               "parameters": {
                 "owner": "OWNER",
                 "repo": "REPO",
@@ -450396,7 +450402,7 @@
           }
         ],
         "previews": [],
-        "descriptionHTML": "<p>This endpoint makes use of <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/overview/resources-in-the-rest-api#hypermedia\">a Hypermedia relation</a> to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the <code>upload_url</code> returned in\nthe response of the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#create-a-release\">Create a release endpoint</a> to upload a release asset.</p>\n<p>You need to use an HTTP client which supports <a href=\"http://en.wikipedia.org/wiki/Server_Name_Indication\">SNI</a> to make calls to this endpoint.</p>\n<p>Most libraries will set the required <code>Content-Length</code> header automatically. Use the required <code>Content-Type</code> header to provide the media type of the asset. For a list of media types, see <a href=\"https://www.iana.org/assignments/media-types/media-types.xhtml\">Media Types</a>. For example: </p>\n<p><code>application/zip</code></p>\n<p>GitHub Enterprise Cloud expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.</p>\n<p>When an upstream failure occurs, you will receive a <code>502 Bad Gateway</code> status. This may leave an empty asset with a state of <code>starter</code>. It can be safely deleted.</p>\n<p><strong>Notes:</strong></p>\n<ul>\n<li>GitHub Enterprise Cloud renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#list-assets-for-a-release\">List assets for a release</a>\"\nendpoint lists the renamed filenames. For more information and help, contact <a href=\"https://support.github.com/contact?tags=dotcom-rest-api\">GitHub Enterprise Cloud Support</a>.</li>\n<li>If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.</li>\n</ul>",
+        "descriptionHTML": "<p>This endpoint makes use of <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/overview/resources-in-the-rest-api#hypermedia\">a Hypermedia relation</a> to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the <code>upload_url</code> returned in\nthe response of the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#create-a-release\">Create a release endpoint</a> to upload a release asset.</p>\n<p>You need to use an HTTP client which supports <a href=\"http://en.wikipedia.org/wiki/Server_Name_Indication\">SNI</a> to make calls to this endpoint.</p>\n<p>Most libraries will set the required <code>Content-Length</code> header automatically. Use the required <code>Content-Type</code> header to provide the media type of the asset. For a list of media types, see <a href=\"https://www.iana.org/assignments/media-types/media-types.xhtml\">Media Types</a>. For example: </p>\n<p><code>application/zip</code></p>\n<p>GitHub Enterprise Cloud expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.</p>\n<p>When an upstream failure occurs, you will receive a <code>502 Bad Gateway</code> status. This may leave an empty asset with a state of <code>starter</code>. It can be safely deleted.</p>\n<p><strong>Notes:</strong></p>\n<ul>\n<li>GitHub Enterprise Cloud renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#list-assets-for-a-release\">List assets for a release</a>\"\nendpoint lists the renamed filenames. For more information and help, contact <a href=\"https://support.github.com/contact?tags=dotcom-rest-api\">GitHub Enterprise Cloud Support</a>.</li>\n<li>To find the <code>release_id</code> query the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-the-latest-release\"><code>GET /repos/{owner}/{repo}/releases/latest</code> endpoint</a>. </li>\n<li>If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.</li>\n</ul>",
         "statusCodes": [
           {
             "httpStatusCode": "201",
@@ -451579,7 +451585,7 @@
             "type": "boolean",
             "name": "delete_branch_on_merge",
             "in": "body",
-            "description": "<p>Either <code>true</code> to allow automatically deleting head branches when pull requests are merged, or <code>false</code> to prevent automatic deletion.</p>",
+            "description": "<p>Either <code>true</code> to allow automatically deleting head branches when pull requests are merged, or <code>false</code> to prevent automatic deletion. <strong>The authenticated user must be an organization owner to set this property to <code>true</code>.</strong></p>",
             "default": false
           },
           {

lib/rest/static/decorated/ghes-3.3.json

@@ -345193,7 +345193,7 @@
               "contentType": "application/octet-stream",
               "description": "Example",
               "acceptHeader": "application/vnd.github.v3+json",
-              "bodyParameters": "@release-asset.gz",
+              "bodyParameters": "@example.zip",
               "parameters": {
                 "owner": "OWNER",
                 "repo": "REPO",
@@ -345484,7 +345484,7 @@
           }
         ],
         "previews": [],
-        "descriptionHTML": "<p>This endpoint makes use of <a href=\"https://docs.github.com/enterprise-server@3.3/rest/overview/resources-in-the-rest-api#hypermedia\">a Hypermedia relation</a> to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the <code>upload_url</code> returned in\nthe response of the <a href=\"https://docs.github.com/enterprise-server@3.3/rest/releases/releases#create-a-release\">Create a release endpoint</a> to upload a release asset.</p>\n<p>You need to use an HTTP client which supports <a href=\"http://en.wikipedia.org/wiki/Server_Name_Indication\">SNI</a> to make calls to this endpoint.</p>\n<p>Most libraries will set the required <code>Content-Length</code> header automatically. Use the required <code>Content-Type</code> header to provide the media type of the asset. For a list of media types, see <a href=\"https://www.iana.org/assignments/media-types/media-types.xhtml\">Media Types</a>. For example: </p>\n<p><code>application/zip</code></p>\n<p>GitHub Enterprise Server expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.</p>\n<p>When an upstream failure occurs, you will receive a <code>502 Bad Gateway</code> status. This may leave an empty asset with a state of <code>starter</code>. It can be safely deleted.</p>\n<p><strong>Notes:</strong></p>\n<ul>\n<li>GitHub Enterprise Server renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"<a href=\"https://docs.github.com/enterprise-server@3.3/rest/reference/repos#list-assets-for-a-release\">List assets for a release</a>\"\nendpoint lists the renamed filenames. For more information and help, contact <a href=\"https://support.github.com/contact?tags=dotcom-rest-api\">GitHub Enterprise Server Support</a>.</li>\n<li>If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.</li>\n</ul>",
+        "descriptionHTML": "<p>This endpoint makes use of <a href=\"https://docs.github.com/enterprise-server@3.3/rest/overview/resources-in-the-rest-api#hypermedia\">a Hypermedia relation</a> to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the <code>upload_url</code> returned in\nthe response of the <a href=\"https://docs.github.com/enterprise-server@3.3/rest/releases/releases#create-a-release\">Create a release endpoint</a> to upload a release asset.</p>\n<p>You need to use an HTTP client which supports <a href=\"http://en.wikipedia.org/wiki/Server_Name_Indication\">SNI</a> to make calls to this endpoint.</p>\n<p>Most libraries will set the required <code>Content-Length</code> header automatically. Use the required <code>Content-Type</code> header to provide the media type of the asset. For a list of media types, see <a href=\"https://www.iana.org/assignments/media-types/media-types.xhtml\">Media Types</a>. For example: </p>\n<p><code>application/zip</code></p>\n<p>GitHub Enterprise Server expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.</p>\n<p>When an upstream failure occurs, you will receive a <code>502 Bad Gateway</code> status. This may leave an empty asset with a state of <code>starter</code>. It can be safely deleted.</p>\n<p><strong>Notes:</strong></p>\n<ul>\n<li>GitHub Enterprise Server renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"<a href=\"https://docs.github.com/enterprise-server@3.3/rest/reference/repos#list-assets-for-a-release\">List assets for a release</a>\"\nendpoint lists the renamed filenames. For more information and help, contact <a href=\"https://support.github.com/contact?tags=dotcom-rest-api\">GitHub Enterprise Server Support</a>.</li>\n<li>To find the <code>release_id</code> query the <a href=\"https://docs.github.com/enterprise-server@3.3/rest/releases/releases#get-the-latest-release\"><code>GET /repos/{owner}/{repo}/releases/latest</code> endpoint</a>. </li>\n<li>If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.</li>\n</ul>",
         "statusCodes": [
           {
             "httpStatusCode": "201",
@@ -346598,7 +346598,7 @@
             "type": "boolean",
             "name": "delete_branch_on_merge",
             "in": "body",
-            "description": "<p>Either <code>true</code> to allow automatically deleting head branches when pull requests are merged, or <code>false</code> to prevent automatic deletion.</p>",
+            "description": "<p>Either <code>true</code> to allow automatically deleting head branches when pull requests are merged, or <code>false</code> to prevent automatic deletion. <strong>The authenticated user must be an organization owner to set this property to <code>true</code>.</strong></p>",
             "default": false
           },
           {