Skip to content

Commit

Permalink
Update OpenAPI Descriptions (github#32418)
Browse files Browse the repository at this point in the history 
Co-authored-by: github-openapi-bot <[email protected]>
  • Loading branch information
@github-openapi-bot
github-openapi-bot and github-openapi-bot authored Nov 7, 2022
1 parent 8f3df18 commit c2ff84b
Show file tree
Hide file tree
Showing 16 changed files with 179 additions and 135 deletions.
28 changes: 16 additions & 12 deletions lib/rest/static/decorated/api.github.com.json
View file

Large diffs are not rendered by default.

28 changes: 16 additions & 12 deletions lib/rest/static/decorated/ghec.json
View file

Large diffs are not rendered by default.

12 changes: 6 additions & 6 deletions lib/rest/static/decorated/ghes-3.3.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -112373,7 +112373,7 @@
"type": "array of strings",
"name": "apps",
"in": "body",
"description": "<p>apps parameter</p>",
"description": "<p>The GitHub Apps that have push access to this branch. Use the slugified version of the app name. <strong>Note</strong>: The list of users, apps, and teams in total is limited to 100 items.</p>",
"isRequired": true
}
],
Expand Down Expand Up @@ -112775,7 +112775,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see <a href=\"https://docs.github.com/[email protected]/github/getting-started-with-github/githubs-products\">GitHub's products</a> in the GitHub Help documentation.</p>\n<p>Grants the specified apps push access for this branch. Only installed GitHub Apps with <code>write</code> access to the <code>contents</code> permission can be added as authorized actors on a protected branch.</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>array</code></td><td>The GitHub Apps that have push access to this branch. Use the app's <code>slug</code>. <strong>Note</strong>: The list of users, apps, and teams in total is limited to 100 items.</td></tr></tbody></table>",
"descriptionHTML": "<p>Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see <a href=\"https://docs.github.com/[email protected]/github/getting-started-with-github/githubs-products\">GitHub's products</a> in the GitHub Help documentation.</p>\n<p>Grants the specified apps push access for this branch. Only installed GitHub Apps with <code>write</code> access to the <code>contents</code> permission can be added as authorized actors on a protected branch.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
Expand Down Expand Up @@ -112829,7 +112829,7 @@
"type": "array of strings",
"name": "apps",
"in": "body",
"description": "<p>apps parameter</p>",
"description": "<p>The GitHub Apps that have push access to this branch. Use the slugified version of the app name. <strong>Note</strong>: The list of users, apps, and teams in total is limited to 100 items.</p>",
"isRequired": true
}
],
Expand Down Expand Up @@ -113231,7 +113231,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see <a href=\"https://docs.github.com/[email protected]/github/getting-started-with-github/githubs-products\">GitHub's products</a> in the GitHub Help documentation.</p>\n<p>Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only installed GitHub Apps with <code>write</code> access to the <code>contents</code> permission can be added as authorized actors on a protected branch.</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>array</code></td><td>The GitHub Apps that have push access to this branch. Use the app's <code>slug</code>. <strong>Note</strong>: The list of users, apps, and teams in total is limited to 100 items.</td></tr></tbody></table>",
"descriptionHTML": "<p>Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see <a href=\"https://docs.github.com/[email protected]/github/getting-started-with-github/githubs-products\">GitHub's products</a> in the GitHub Help documentation.</p>\n<p>Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only installed GitHub Apps with <code>write</code> access to the <code>contents</code> permission can be added as authorized actors on a protected branch.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
Expand Down Expand Up @@ -113285,7 +113285,7 @@
"type": "array of strings",
"name": "apps",
"in": "body",
"description": "<p>apps parameter</p>",
"description": "<p>The GitHub Apps that have push access to this branch. Use the slugified version of the app name. <strong>Note</strong>: The list of users, apps, and teams in total is limited to 100 items.</p>",
"isRequired": true
}
],
Expand Down Expand Up @@ -113687,7 +113687,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see <a href=\"https://docs.github.com/[email protected]/github/getting-started-with-github/githubs-products\">GitHub's products</a> in the GitHub Help documentation.</p>\n<p>Removes the ability of an app to push to this branch. Only installed GitHub Apps with <code>write</code> access to the <code>contents</code> permission can be added as authorized actors on a protected branch.</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>array</code></td><td>The GitHub Apps that have push access to this branch. Use the app's <code>slug</code>. <strong>Note</strong>: The list of users, apps, and teams in total is limited to 100 items.</td></tr></tbody></table>",
"descriptionHTML": "<p>Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see <a href=\"https://docs.github.com/[email protected]/github/getting-started-with-github/githubs-products\">GitHub's products</a> in the GitHub Help documentation.</p>\n<p>Removes the ability of an app to push to this branch. Only installed GitHub Apps with <code>write</code> access to the <code>contents</code> permission can be added as authorized actors on a protected branch.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
Expand Down
14 changes: 7 additions & 7 deletions lib/rest/static/decorated/ghes-3.4.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -117669,7 +117669,7 @@
"type": "array of strings",
"name": "apps",
"in": "body",
"description": "<p>apps parameter</p>",
"description": "<p>The GitHub Apps that have push access to this branch. Use the slugified version of the app name. <strong>Note</strong>: The list of users, apps, and teams in total is limited to 100 items.</p>",
"isRequired": true
}
],
Expand Down Expand Up @@ -118071,7 +118071,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see <a href=\"https://docs.github.com/[email protected]/github/getting-started-with-github/githubs-products\">GitHub's products</a> in the GitHub Help documentation.</p>\n<p>Grants the specified apps push access for this branch. Only installed GitHub Apps with <code>write</code> access to the <code>contents</code> permission can be added as authorized actors on a protected branch.</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>array</code></td><td>The GitHub Apps that have push access to this branch. Use the app's <code>slug</code>. <strong>Note</strong>: The list of users, apps, and teams in total is limited to 100 items.</td></tr></tbody></table>",
"descriptionHTML": "<p>Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see <a href=\"https://docs.github.com/[email protected]/github/getting-started-with-github/githubs-products\">GitHub's products</a> in the GitHub Help documentation.</p>\n<p>Grants the specified apps push access for this branch. Only installed GitHub Apps with <code>write</code> access to the <code>contents</code> permission can be added as authorized actors on a protected branch.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
Expand Down Expand Up @@ -118125,7 +118125,7 @@
"type": "array of strings",
"name": "apps",
"in": "body",
"description": "<p>apps parameter</p>",
"description": "<p>The GitHub Apps that have push access to this branch. Use the slugified version of the app name. <strong>Note</strong>: The list of users, apps, and teams in total is limited to 100 items.</p>",
"isRequired": true
}
],
Expand Down Expand Up @@ -118527,7 +118527,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see <a href=\"https://docs.github.com/[email protected]/github/getting-started-with-github/githubs-products\">GitHub's products</a> in the GitHub Help documentation.</p>\n<p>Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only installed GitHub Apps with <code>write</code> access to the <code>contents</code> permission can be added as authorized actors on a protected branch.</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>array</code></td><td>The GitHub Apps that have push access to this branch. Use the app's <code>slug</code>. <strong>Note</strong>: The list of users, apps, and teams in total is limited to 100 items.</td></tr></tbody></table>",
"descriptionHTML": "<p>Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see <a href=\"https://docs.github.com/[email protected]/github/getting-started-with-github/githubs-products\">GitHub's products</a> in the GitHub Help documentation.</p>\n<p>Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only installed GitHub Apps with <code>write</code> access to the <code>contents</code> permission can be added as authorized actors on a protected branch.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
Expand Down Expand Up @@ -118581,7 +118581,7 @@
"type": "array of strings",
"name": "apps",
"in": "body",
"description": "<p>apps parameter</p>",
"description": "<p>The GitHub Apps that have push access to this branch. Use the slugified version of the app name. <strong>Note</strong>: The list of users, apps, and teams in total is limited to 100 items.</p>",
"isRequired": true
}
],
Expand Down Expand Up @@ -118983,7 +118983,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see <a href=\"https://docs.github.com/[email protected]/github/getting-started-with-github/githubs-products\">GitHub's products</a> in the GitHub Help documentation.</p>\n<p>Removes the ability of an app to push to this branch. Only installed GitHub Apps with <code>write</code> access to the <code>contents</code> permission can be added as authorized actors on a protected branch.</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>array</code></td><td>The GitHub Apps that have push access to this branch. Use the app's <code>slug</code>. <strong>Note</strong>: The list of users, apps, and teams in total is limited to 100 items.</td></tr></tbody></table>",
"descriptionHTML": "<p>Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see <a href=\"https://docs.github.com/[email protected]/github/getting-started-with-github/githubs-products\">GitHub's products</a> in the GitHub Help documentation.</p>\n<p>Removes the ability of an app to push to this branch. Only installed GitHub Apps with <code>write</code> access to the <code>contents</code> permission can be added as authorized actors on a protected branch.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
Expand Down Expand Up @@ -296539,7 +296539,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>List the custom repository roles available in this organization. In order to see custom\nrepository roles in an organization, the authenticated user must be an organization owner.</p>\n<p>To use this endpoint the authenticated user must be an administrator for the organization or of an repository of the organizaiton and must use an access token with <code>admin:org repo</code> scope.\nGitHub Apps must have the <code>organization_custom_roles:read</code> organization permission to use this endpoint.</p>\n<p>For more information on custom repository roles, see \"<a href=\"https://docs.github.com/[email protected]/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization\">Managing custom repository roles for an organization</a>\".</p>",
"descriptionHTML": "<p>List the custom repository roles available in this organization. In order to see custom\nrepository roles in an organization, the authenticated user must be an organization owner.</p>\n<p>To use this endpoint the authenticated user must be an administrator for the organization or of an repository of the organizaiton and must use an access token with <code>admin:org repo</code> scope.\nGitHub Apps must have the <code>organization_custom_roles:read</code> organization permission to use this endpoint.</p>\n<p>For more information on custom repository roles, see \"<a href=\"https://docs.github.com/[email protected]/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles\">About custom repository roles</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
Expand Down
Loading

0 comments on commit c2ff84b

Please sign in to comment.