Update OpenAPI Description (#56005)

Co-authored-by: Sunbrye Ly <[email protected]>

Author: docs-bot

src/github-apps/lib/config.json

@@ -60,5 +60,5 @@
       "2022-11-28"
     ]
   },
-  "sha": "23d16a0c0808c8241b1076d63e8d3f2e75cb6632"
+  "sha": "7fa9b34e16fec58ad8d856fb0c84488e53574beb"
 }

src/rest/data/fpt-2022-11-28/schema.json

@@ -12989,13 +12989,13 @@
           }
         ],
         "previews": [],
-        "descriptionHTML": "<p>Gets a single environment secret without revealing its encrypted value.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read secrets.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
         "statusCodes": [
           {
             "httpStatusCode": "200",
             "description": "<p>OK</p>"
           }
-        ]
+        ],
+        "descriptionHTML": "<p>Gets a single environment secret without revealing its encrypted value.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read secrets.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
       },
       {
         "serverUrl": "https://api.github.com",
@@ -13212,13 +13212,13 @@
           }
         ],
         "previews": [],
-        "descriptionHTML": "<p>Deletes a secret in an environment using the secret name.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read secrets.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
         "statusCodes": [
           {
             "httpStatusCode": "204",
             "description": "<p>Default response</p>"
           }
-        ]
+        ],
+        "descriptionHTML": "<p>Deletes a secret in an environment using the secret name.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read secrets.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
       }
     ],
     "self-hosted-runner-groups": [
@@ -230076,7 +230076,6 @@
           }
         ],
         "previews": [],
-        "descriptionHTML": "<p>Select the repositories that will use a user's development environment secret.</p>\n<p>The authenticated user must have Codespaces access to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>codespace</code> or <code>codespace:secrets</code> scope to use this endpoint.</p>",
         "statusCodes": [
           {
             "httpStatusCode": "204",
@@ -230098,7 +230097,8 @@
             "httpStatusCode": "500",
             "description": "<p>Internal Error</p>"
           }
-        ]
+        ],
+        "descriptionHTML": "<p>Select the repositories that will use a user's development environment secret.</p>\n<p>The authenticated user must have Codespaces access to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>codespace</code> or <code>codespace:secrets</code> scope to use this endpoint.</p>"
       },
       {
         "serverUrl": "https://api.github.com",
@@ -272545,13 +272545,13 @@
           }
         ],
         "previews": [],
-        "descriptionHTML": "<p>Updates a deployment branch or tag policy for an environment.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
         "statusCodes": [
           {
             "httpStatusCode": "200",
             "description": "<p>OK</p>"
           }
-        ]
+        ],
+        "descriptionHTML": "<p>Updates a deployment branch or tag policy for an environment.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
       },
       {
         "serverUrl": "https://api.github.com",
@@ -317125,13 +317125,13 @@
           }
         ],
         "previews": [],
-        "descriptionHTML": "<p>Removes all interaction restrictions from public repositories in the given organization. You must be an organization owner to remove restrictions.</p>",
         "statusCodes": [
           {
             "httpStatusCode": "204",
             "description": "<p>No Content</p>"
           }
-        ]
+        ],
+        "descriptionHTML": "<p>Removes all interaction restrictions from public repositories in the given organization. You must be an organization owner to remove restrictions.</p>"
       }
     ],
     "repos": [
@@ -526760,13 +526760,13 @@
           }
         ],
         "previews": [],
-        "descriptionHTML": "<div class=\"ghd-alert ghd-alert-accent\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a repository by <code>repository_id</code> using the route <code>DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id</code>.</p>\n</div>\n<p>Delete a reaction to an <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue\">issue</a>.</p>",
         "statusCodes": [
           {
             "httpStatusCode": "204",
             "description": "<p>No Content</p>"
           }
-        ]
+        ],
+        "descriptionHTML": "<div class=\"ghd-alert ghd-alert-accent\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a repository by <code>repository_id</code> using the route <code>DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id</code>.</p>\n</div>\n<p>Delete a reaction to an <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue\">issue</a>.</p>"
       },
       {
         "serverUrl": "https://api.github.com",
@@ -662813,13 +662813,13 @@
           }
         ],
         "previews": [],
-        "descriptionHTML": "<p>List IdP groups connected to a team on GitHub Enterprise Cloud.</p>\n<p>Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see <a href=\"https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products\">GitHub's products</a> in the GitHub Help documentation.</p>\n<div class=\"ghd-alert ghd-alert-accent\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>GET /organizations/{org_id}/team/{team_id}/team-sync/group-mappings</code>.</p>\n</div>",
         "statusCodes": [
           {
             "httpStatusCode": "200",
             "description": "<p>OK</p>"
           }
-        ]
+        ],
+        "descriptionHTML": "<p>List IdP groups connected to a team on GitHub Enterprise Cloud.</p>\n<p>Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see <a href=\"https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products\">GitHub's products</a> in the GitHub Help documentation.</p>\n<div class=\"ghd-alert ghd-alert-accent\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>GET /organizations/{org_id}/team/{team_id}/team-sync/group-mappings</code>.</p>\n</div>"
       },
       {
         "serverUrl": "https://api.github.com",

src/rest/data/ghec-2022-11-28/schema.json

@@ -11486,13 +11486,13 @@
           }
         ],
         "previews": [],
-        "descriptionHTML": "<p>Deletes a self-hosted runner group for an organization.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
         "statusCodes": [
           {
             "httpStatusCode": "204",
             "description": "<p>No Content</p>"
           }
-        ]
+        ],
+        "descriptionHTML": "<p>Deletes a self-hosted runner group for an organization.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
       },
       {
         "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -28252,13 +28252,13 @@
           }
         ],
         "previews": [],
-        "descriptionHTML": "<p>Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look\nfor <code>Location:</code> in the response header to find the URL for the download.</p>\n<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
         "statusCodes": [
           {
             "httpStatusCode": "302",
             "description": "<p>Found</p>"
           }
-        ]
+        ],
+        "descriptionHTML": "<p>Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look\nfor <code>Location:</code> in the response header to find the URL for the download.</p>\n<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
       },
       {
         "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -91154,13 +91154,13 @@
           }
         ],
         "previews": [],
-        "descriptionHTML": "<p>Sets the announcement banner to display for the organization.</p>",
         "statusCodes": [
           {
             "httpStatusCode": "200",
             "description": "<p>OK</p>"
           }
-        ]
+        ],
+        "descriptionHTML": "<p>Sets the announcement banner to display for the organization.</p>"
       },
       {
         "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -209661,13 +209661,13 @@
           }
         ],
         "previews": [],
-        "descriptionHTML": "",
         "statusCodes": [
           {
             "httpStatusCode": "200",
             "description": "<p>OK</p>"
           }
-        ]
+        ],
+        "descriptionHTML": ""
       },
       {
         "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -543048,13 +543048,13 @@
           }
         ],
         "previews": [],
-        "descriptionHTML": "<div class=\"ghd-alert ghd-alert-attention\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z\"></path></svg>Warning</p>\n<p>\n<strong>Endpoint closing down notice:</strong> This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/[email protected]/rest/teams/discussions#create-a-discussion\"><code>Create a discussion</code></a> endpoint.</p>\n</div>\n<p>Creates a new discussion post on a team's page.</p>\n<p>This endpoint triggers <a href=\"https://docs.github.com/[email protected]/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"<a href=\"https://docs.github.com/[email protected]/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits\">Rate limits for the API</a>\" and \"<a href=\"https://docs.github.com/[email protected]/rest/guides/best-practices-for-using-the-rest-api\">Best practices for using the REST API</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>write:discussion</code> scope to use this endpoint.</p>",
         "statusCodes": [
           {
             "httpStatusCode": "201",
             "description": "<p>Created</p>"
           }
-        ]
+        ],
+        "descriptionHTML": "<div class=\"ghd-alert ghd-alert-attention\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z\"></path></svg>Warning</p>\n<p>\n<strong>Endpoint closing down notice:</strong> This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/[email protected]/rest/teams/discussions#create-a-discussion\"><code>Create a discussion</code></a> endpoint.</p>\n</div>\n<p>Creates a new discussion post on a team's page.</p>\n<p>This endpoint triggers <a href=\"https://docs.github.com/[email protected]/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"<a href=\"https://docs.github.com/[email protected]/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits\">Rate limits for the API</a>\" and \"<a href=\"https://docs.github.com/[email protected]/rest/guides/best-practices-for-using-the-rest-api\">Best practices for using the REST API</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>write:discussion</code> scope to use this endpoint.</p>"
       },
       {
         "serverUrl": "http(s)://HOSTNAME/api/v3",

src/rest/data/ghes-3.17-2022-11-28/schema.json

@@ -47,5 +47,5 @@
       ]
     }
   },
-  "sha": "23d16a0c0808c8241b1076d63e8d3f2e75cb6632"
+  "sha": "7fa9b34e16fec58ad8d856fb0c84488e53574beb"
 }

src/rest/lib/config.json

@@ -1,3 +1,3 @@
 {
-  "sha": "23d16a0c0808c8241b1076d63e8d3f2e75cb6632"
+  "sha": "7fa9b34e16fec58ad8d856fb0c84488e53574beb"
 }