Merge pull request github#27272 from github/openapi-update-49f88f1ef70b6e0f3a215b0db2260d450b3447e893be00ab4daec68d68cfb02d

Update OpenAPI  Descriptions

Author: jules-p

lib/redirects/static/client-side-rest-api-redirects.json

@@ -188,6 +188,8 @@
   "/rest/actions#disable-a-selected-organization-for-github-actions-in-an-enterprise": "/rest/actions/permissions#disable-a-selected-organization-for-github-actions-in-an-enterprise",
   "/rest/actions#get-allowed-actions-for-an-enterprise": "/rest/actions/permissions#get-allowed-actions-for-an-enterprise",
   "/rest/actions#set-allowed-actions-for-an-enterprise": "/rest/actions/permissions#set-allowed-actions-for-an-enterprise",
+  "/rest/actions#get-default-workflow-permissions-for-an-enterprise": "/rest/actions/permissions#get-default-workflow-permissions-for-an-enterprise",
+  "/rest/actions#set-default-workflow-permissions-for-an-enterprise": "/rest/actions/permissions#set-default-workflow-permissions-for-an-enterprise",
   "/rest/actions#list-self-hosted-runner-groups-for-an-enterprise": "/rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-enterprise",
   "/rest/actions#self-hosted-runner-groups": "/rest/actions/self-hosted-runner-groups",
   "/rest/actions#create-self-hosted-runner-group-for-an-enterprise": "/rest/actions/self-hosted-runner-groups#create-self-hosted-runner-group-for-an-enterprise",
@@ -469,6 +471,8 @@
   "/rest/actions#set-workflow-access-to-a-repository": "/rest/actions/permissions#set-workflow-access-to-a-repository",
   "/rest/actions#get-allowed-actions-for-a-repository": "/rest/actions/permissions#get-allowed-actions-for-a-repository",
   "/rest/actions#set-allowed-actions-for-a-repository": "/rest/actions/permissions#set-allowed-actions-for-a-repository",
+  "/rest/actions#get-default-workflow-permissions-for-a-repository": "/rest/actions/permissions#get-default-workflow-permissions-for-a-repository",
+  "/rest/actions#set-default-workflow-permissions-for-a-repository": "/rest/actions/permissions#set-default-workflow-permissions-for-a-repository",
   "/rest/actions#list-self-hosted-runners-for-a-repository": "/rest/actions/self-hosted-runners#list-self-hosted-runners-for-a-repository",
   "/rest/actions#list-runner-applications-for-a-repository": "/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository",
   "/rest/actions#create-a-registration-token-for-a-repository": "/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository",

lib/rest/static/apps/enabled-for-apps.json

@@ -5,6 +5,14 @@
         "verb": "get",
         "requestPath": "/enterprises/{enterprise}/actions/cache/usage"
       },
+      {
+        "verb": "get",
+        "requestPath": "/enterprises/{enterprise}/actions/permissions/workflow"
+      },
+      {
+        "verb": "put",
+        "requestPath": "/enterprises/{enterprise}/actions/permissions/workflow"
+      },
       {
         "verb": "get",
         "requestPath": "/orgs/{org}/actions/cache/usage"
@@ -241,6 +249,14 @@
         "verb": "put",
         "requestPath": "/repos/{owner}/{repo}/actions/permissions/selected-actions"
       },
+      {
+        "verb": "get",
+        "requestPath": "/repos/{owner}/{repo}/actions/permissions/workflow"
+      },
+      {
+        "verb": "put",
+        "requestPath": "/repos/{owner}/{repo}/actions/permissions/workflow"
+      },
       {
         "verb": "get",
         "requestPath": "/repos/{owner}/{repo}/actions/runners"

lib/rest/static/decorated/api.github.com.json

@@ -28343,7 +28343,7 @@
             "description": "<p>Validation failed</p>"
           }
         ],
-        "descriptionHTML": "<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. See \"<a href=\"https://docs.github.com/[email protected]/rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/[email protected]/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>For more information on permission levels, see \"<a href=\"https://docs.github.com/[email protected]/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization\">Repository permission levels for an organization</a>\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:</p>\n<pre><code>Cannot assign {member} permission of {role name}\n</code></pre>\n<p>Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/[email protected]/rest/overview/resources-in-the-rest-api#http-verbs\">HTTP verbs</a>.\"</p>\n<p>The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the <a href=\"https://docs.github.com/[email protected]/rest/reference/repos#invitations\">repository invitations API endpoints</a>.</p>\n<p><strong>Rate limits</strong></p>\n<p>You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.</p>"
+        "descriptionHTML": "<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. See \"<a href=\"https://docs.github.com/[email protected]/rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/[email protected]/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>For more information on permission levels, see \"<a href=\"https://docs.github.com/[email protected]/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization\">Repository permission levels for an organization</a>\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:</p>\n<pre><code>Cannot assign {member} permission of {role name}\n</code></pre>\n<p>Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/[email protected]/rest/overview/resources-in-the-rest-api#http-verbs\">HTTP verbs</a>.\"</p>\n<p>The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the <a href=\"https://docs.github.com/[email protected]/rest/reference/repos#invitations\">repository invitations API endpoints</a>.</p>\n<p><strong>Updating an existing collaborator's permission level</strong></p>\n<p>The endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different <code>permission</code> parameter. The response will be a <code>204</code>, with no other indication that the permission level changed.</p>\n<p><strong>Rate limits</strong></p>\n<p>You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.</p>"
       },
       {
         "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -71075,13 +71075,13 @@
         "bodyParameters": [
           {
             "type": "string",
-            "description": "<p><strong>Required</strong>. A custom webhook event name.</p>",
+            "description": "<p><strong>Required</strong>. A custom webhook event name. Must be 100 characters or fewer.</p>",
             "minLength": 1,
             "maxLength": 100,
             "name": "event_type",
             "in": "body",
             "rawType": "string",
-            "rawDescription": "A custom webhook event name.",
+            "rawDescription": "A custom webhook event name. Must be 100 characters or fewer.",
             "childParamsGroups": []
           },
           {

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

@@ -29411,7 +29411,7 @@
             "description": "<p>Validation failed</p>"
           }
         ],
-        "descriptionHTML": "<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. See \"<a href=\"https://docs.github.com/[email protected]/rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/[email protected]/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>For more information on permission levels, see \"<a href=\"https://docs.github.com/[email protected]/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization\">Repository permission levels for an organization</a>\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:</p>\n<pre><code>Cannot assign {member} permission of {role name}\n</code></pre>\n<p>Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/[email protected]/rest/overview/resources-in-the-rest-api#http-verbs\">HTTP verbs</a>.\"</p>\n<p>The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the <a href=\"https://docs.github.com/[email protected]/rest/reference/repos#invitations\">repository invitations API endpoints</a>.</p>\n<p><strong>Rate limits</strong></p>\n<p>You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.</p>"
+        "descriptionHTML": "<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. See \"<a href=\"https://docs.github.com/[email protected]/rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/[email protected]/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>For more information on permission levels, see \"<a href=\"https://docs.github.com/[email protected]/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization\">Repository permission levels for an organization</a>\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:</p>\n<pre><code>Cannot assign {member} permission of {role name}\n</code></pre>\n<p>Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/[email protected]/rest/overview/resources-in-the-rest-api#http-verbs\">HTTP verbs</a>.\"</p>\n<p>The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the <a href=\"https://docs.github.com/[email protected]/rest/reference/repos#invitations\">repository invitations API endpoints</a>.</p>\n<p><strong>Updating an existing collaborator's permission level</strong></p>\n<p>The endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different <code>permission</code> parameter. The response will be a <code>204</code>, with no other indication that the permission level changed.</p>\n<p><strong>Rate limits</strong></p>\n<p>You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.</p>"
       },
       {
         "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -73867,13 +73867,13 @@
         "bodyParameters": [
           {
             "type": "string",
-            "description": "<p><strong>Required</strong>. A custom webhook event name.</p>",
+            "description": "<p><strong>Required</strong>. A custom webhook event name. Must be 100 characters or fewer.</p>",
             "minLength": 1,
             "maxLength": 100,
             "name": "event_type",
             "in": "body",
             "rawType": "string",
-            "rawDescription": "A custom webhook event name.",
+            "rawDescription": "A custom webhook event name. Must be 100 characters or fewer.",
             "childParamsGroups": []
           },
           {

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

@@ -29566,7 +29566,7 @@
             "description": "<p>Validation failed</p>"
           }
         ],
-        "descriptionHTML": "<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. See \"<a href=\"https://docs.github.com/[email protected]/rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/[email protected]/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>For more information on permission levels, see \"<a href=\"https://docs.github.com/[email protected]/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization\">Repository permission levels for an organization</a>\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:</p>\n<pre><code>Cannot assign {member} permission of {role name}\n</code></pre>\n<p>Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/[email protected]/rest/overview/resources-in-the-rest-api#http-verbs\">HTTP verbs</a>.\"</p>\n<p>The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the <a href=\"https://docs.github.com/[email protected]/rest/reference/repos#invitations\">repository invitations API endpoints</a>.</p>\n<p><strong>Rate limits</strong></p>\n<p>You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.</p>"
+        "descriptionHTML": "<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. See \"<a href=\"https://docs.github.com/[email protected]/rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/[email protected]/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>For more information on permission levels, see \"<a href=\"https://docs.github.com/[email protected]/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization\">Repository permission levels for an organization</a>\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:</p>\n<pre><code>Cannot assign {member} permission of {role name}\n</code></pre>\n<p>Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/[email protected]/rest/overview/resources-in-the-rest-api#http-verbs\">HTTP verbs</a>.\"</p>\n<p>The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the <a href=\"https://docs.github.com/[email protected]/rest/reference/repos#invitations\">repository invitations API endpoints</a>.</p>\n<p><strong>Updating an existing collaborator's permission level</strong></p>\n<p>The endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different <code>permission</code> parameter. The response will be a <code>204</code>, with no other indication that the permission level changed.</p>\n<p><strong>Rate limits</strong></p>\n<p>You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.</p>"
       },
       {
         "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -73808,13 +73808,13 @@
         "bodyParameters": [
           {
             "type": "string",
-            "description": "<p><strong>Required</strong>. A custom webhook event name.</p>",
+            "description": "<p><strong>Required</strong>. A custom webhook event name. Must be 100 characters or fewer.</p>",
             "minLength": 1,
             "maxLength": 100,
             "name": "event_type",
             "in": "body",
             "rawType": "string",
-            "rawDescription": "A custom webhook event name.",
+            "rawDescription": "A custom webhook event name. Must be 100 characters or fewer.",
             "childParamsGroups": []
           },
           {