jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-23 21:07:12 -05:00
Code Issues Projects Releases Wiki Activity

Update OpenAPI Description (#52177)

Browse Source 
Co-authored-by: Siara <108543037+SiaraMist@users.noreply.github.com>
This commit is contained in:
docs-bot
2024-09-03 17:04:49 -07:00
committed by GitHub
parent 126862b34a
commit ba4dd2e844
9 changed files with 51 additions and 96 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/github-apps/lib/config.json
View File

@@ -60,5 +60,5 @@
"2022-11-28"
]
},
"sha": "2a29b70c717f70a4afa122ed166a6a885a1d7d77"
"sha": "38baa7aebf29fe927aac6aa0ae769b7a8d3204ca"
}

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

@@ -362004,8 +362004,7 @@
"OrganizationAdmin",
"RepositoryRole",
"Team",
"DeployKey",
"EnterpriseTeam"
"DeployKey"
],
"description": "The type of actor that can bypass a ruleset.\n"
},
@@ -363247,8 +363246,7 @@
"OrganizationAdmin",
"RepositoryRole",
"Team",
"DeployKey",
"EnterpriseTeam"
"DeployKey"
]
},
{
@@ -364533,8 +364531,7 @@
"OrganizationAdmin",
"RepositoryRole",
"Team",
"DeployKey",
"EnterpriseTeam"
"DeployKey"
],
"description": "The type of actor that can bypass a ruleset.\n"
},
@@ -365888,8 +365885,7 @@
"OrganizationAdmin",
"RepositoryRole",
"Team",
"DeployKey",
"EnterpriseTeam"
"DeployKey"
],
"description": "The type of actor that can bypass a ruleset.\n"
},
@@ -367136,8 +367132,7 @@
"OrganizationAdmin",
"RepositoryRole",
"Team",
"DeployKey",
"EnterpriseTeam"
"DeployKey"
]
},
{
@@ -368423,8 +368418,7 @@
"OrganizationAdmin",
"RepositoryRole",
"Team",
"DeployKey",
"EnterpriseTeam"
"DeployKey"
],
"description": "The type of actor that can bypass a ruleset.\n"
},
@@ -490413,8 +490407,7 @@
"OrganizationAdmin",
"RepositoryRole",
"Team",
"DeployKey",
"EnterpriseTeam"
"DeployKey"
],
"description": "The type of actor that can bypass a ruleset.\n"
},
@@ -491665,8 +491658,7 @@
"OrganizationAdmin",
"RepositoryRole",
"Team",
"DeployKey",
"EnterpriseTeam"
"DeployKey"
]
},
{
@@ -492767,8 +492759,7 @@
"OrganizationAdmin",
"RepositoryRole",
"Team",
"DeployKey",
"EnterpriseTeam"
"DeployKey"
],
"description": "The type of actor that can bypass a ruleset.\n"
},
@@ -494133,8 +494124,7 @@
"OrganizationAdmin",
"RepositoryRole",
"Team",
"DeployKey",
"EnterpriseTeam"
"DeployKey"
],
"description": "The type of actor that can bypass a ruleset.\n"
},
@@ -495390,8 +495380,7 @@
"OrganizationAdmin",
"RepositoryRole",
"Team",
"DeployKey",
"EnterpriseTeam"
"DeployKey"
]
},
{
@@ -496493,8 +496482,7 @@
"OrganizationAdmin",
"RepositoryRole",
"Team",
"DeployKey",
"EnterpriseTeam"
"DeployKey"
],
"description": "The type of actor that can bypass a ruleset.\n"
},

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

@@ -379877,7 +379877,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Creates a custom organization role that can be assigned to users and teams, granting them specific permissions over the organization. For more information on custom organization roles, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles\">Managing people's access to your organization with roles</a>.\"</p>\n<p>To use this endpoint, the authenticated user must be one of:</p>\n<ul>\n<li>An administrator for the organization.</li>\n<li>A user, or a user on a team, with the fine-grained permissions of <code>write_organization_custom_org_role</code> in the organization.</li>\n</ul>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p>Creates a custom organization role that can be assigned to users and teams, granting them specific\npermissions over the organization and optionally across all repositories in the organization. For\nmore information on custom organization roles, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles\">Managing people's access to your organization with roles</a>.\"</p>\n<p>To include repository permissions in an organization role, you must also include the <code>base_role</code>\nfield, which is one of <code>read</code>, <code>write</code>, <code>triage</code>, <code>maintain</code>, or <code>admin</code> (or <code>none</code> if no base role is set). This base role provides a set of\nfine-grained permissions as well as implicit permissions - those that aren't exposed as fine-grained permissions\nand can only be granted through the base role (like \"reading a repo\"). If you include repository permissions, those\npermissions apply across all of the repositories in the organization. You do not have to include organization permissions\nin order to add repository permissions.</p>\n<p>See \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#list-repository-fine-grained-permissions-for-an-organization\">List repository permissions</a>\" for valid repository permissions.</p>\n<p>To use this endpoint, the authenticated user must be one of:</p>\n<ul>\n<li>An administrator for the organization.</li>\n<li>A user, or a user on a team, with the fine-grained permissions of <code>write_organization_custom_org_role</code> in the organization.</li>\n</ul>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -380992,7 +380992,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles\">Managing people's access to your organization with roles</a>.\"</p>\n<p>To use this endpoint, the authenticated user must be one of:</p>\n<ul>\n<li>An administrator for the organization.</li>\n<li>A user, or a user on a team, with the fine-grained permissions of <code>write_organization_custom_org_role</code> in the organization.</li>\n</ul>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p>Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles\">Managing people's access to your organization with roles</a>.\"</p>\n<p>If the update would add repository permissions, the <code>base_role</code> must also be set to a value besides <code>none</code>, either\npreviously or as part of the update.\nIf the update sets the <code>base_role</code> field to <code>none</code>, you must also remove all of the repository\npermissions as well, otherwise the update will fail.</p>\n<p>To use this endpoint, the authenticated user must be one of:</p>\n<ul>\n<li>An administrator for the organization.</li>\n<li>A user, or a user on a team, with the fine-grained permissions of <code>write_organization_custom_org_role</code> in the organization.</li>\n</ul>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -386221,8 +386221,7 @@
"OrganizationAdmin",
"RepositoryRole",
"Team",
"DeployKey",
"EnterpriseTeam"
"DeployKey"
],
"description": "The type of actor that can bypass a ruleset.\n"
},
@@ -387464,8 +387463,7 @@
"OrganizationAdmin",
"RepositoryRole",
"Team",
"DeployKey",
"EnterpriseTeam"
"DeployKey"
]
},
{
@@ -388750,8 +388748,7 @@
"OrganizationAdmin",
"RepositoryRole",
"Team",
"DeployKey",
"EnterpriseTeam"
"DeployKey"
],
"description": "The type of actor that can bypass a ruleset.\n"
},
@@ -390105,8 +390102,7 @@
"OrganizationAdmin",
"RepositoryRole",
"Team",
"DeployKey",
"EnterpriseTeam"
"DeployKey"
],
"description": "The type of actor that can bypass a ruleset.\n"
},
@@ -391353,8 +391349,7 @@
"OrganizationAdmin",
"RepositoryRole",
"Team",
"DeployKey",
"EnterpriseTeam"
"DeployKey"
]
},
{
@@ -392640,8 +392635,7 @@
"OrganizationAdmin",
"RepositoryRole",
"Team",
"DeployKey",
"EnterpriseTeam"
"DeployKey"
],
"description": "The type of actor that can bypass a ruleset.\n"
},
@@ -515025,8 +515019,7 @@
"OrganizationAdmin",
"RepositoryRole",
"Team",
"DeployKey",
"EnterpriseTeam"
"DeployKey"
],
"description": "The type of actor that can bypass a ruleset.\n"
},
@@ -516277,8 +516270,7 @@
"OrganizationAdmin",
"RepositoryRole",
"Team",
"DeployKey",
"EnterpriseTeam"
"DeployKey"
]
},
{
@@ -517379,8 +517371,7 @@
"OrganizationAdmin",
"RepositoryRole",
"Team",
"DeployKey",
"EnterpriseTeam"
"DeployKey"
],
"description": "The type of actor that can bypass a ruleset.\n"
},
@@ -518745,8 +518736,7 @@
"OrganizationAdmin",
"RepositoryRole",
"Team",
"DeployKey",
"EnterpriseTeam"
"DeployKey"
],
"description": "The type of actor that can bypass a ruleset.\n"
},
@@ -520002,8 +519992,7 @@
"OrganizationAdmin",
"RepositoryRole",
"Team",
"DeployKey",
"EnterpriseTeam"
"DeployKey"
]
},
{
@@ -521105,8 +521094,7 @@
"OrganizationAdmin",
"RepositoryRole",
"Team",
"DeployKey",
"EnterpriseTeam"
"DeployKey"
],
"description": "The type of actor that can bypass a ruleset.\n"
},

38
src/rest/data/ghes-3.14-2022-11-28/schema.json
View File

@@ -329803,7 +329803,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Creates a custom organization role that can be assigned to users and teams, granting them specific permissions over the organization. For more information on custom organization roles, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles\">Managing people's access to your organization with roles</a>.\"</p>\n<p>To use this endpoint, the authenticated user must be one of:</p>\n<ul>\n<li>An administrator for the organization.</li>\n<li>A user, or a user on a team, with the fine-grained permissions of <code>write_organization_custom_org_role</code> in the organization.</li>\n</ul>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p>Creates a custom organization role that can be assigned to users and teams, granting them specific\npermissions over the organization and optionally across all repositories in the organization. For\nmore information on custom organization roles, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles\">Managing people's access to your organization with roles</a>.\"</p>\n<p>To use this endpoint, the authenticated user must be one of:</p>\n<ul>\n<li>An administrator for the organization.</li>\n<li>A user, or a user on a team, with the fine-grained permissions of <code>write_organization_custom_org_role</code> in the organization.</li>\n</ul>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -336079,8 +336079,7 @@
"OrganizationAdmin",
"RepositoryRole",
"Team",
"DeployKey",
"EnterpriseTeam"
"DeployKey"
],
"description": "The type of actor that can bypass a ruleset.\n"
},
@@ -337245,8 +337244,7 @@
"OrganizationAdmin",
"RepositoryRole",
"Team",
"DeployKey",
"EnterpriseTeam"
"DeployKey"
]
},
{
@@ -338454,8 +338452,7 @@
"OrganizationAdmin",
"RepositoryRole",
"Team",
"DeployKey",
"EnterpriseTeam"
"DeployKey"
],
"description": "The type of actor that can bypass a ruleset.\n"
},
@@ -339732,8 +339729,7 @@
"OrganizationAdmin",
"RepositoryRole",
"Team",
"DeployKey",
"EnterpriseTeam"
"DeployKey"
],
"description": "The type of actor that can bypass a ruleset.\n"
},
@@ -340903,8 +340899,7 @@
"OrganizationAdmin",
"RepositoryRole",
"Team",
"DeployKey",
"EnterpriseTeam"
"DeployKey"
]
},
{
@@ -342113,8 +342108,7 @@
"OrganizationAdmin",
"RepositoryRole",
"Team",
"DeployKey",
"EnterpriseTeam"
"DeployKey"
],
"description": "The type of actor that can bypass a ruleset.\n"
},
@@ -462663,8 +462657,7 @@
"OrganizationAdmin",
"RepositoryRole",
"Team",
"DeployKey",
"EnterpriseTeam"
"DeployKey"
],
"description": "The type of actor that can bypass a ruleset.\n"
},
@@ -463838,8 +463831,7 @@
"OrganizationAdmin",
"RepositoryRole",
"Team",
"DeployKey",
"EnterpriseTeam"
"DeployKey"
]
},
{
@@ -464863,8 +464855,7 @@
"OrganizationAdmin",
"RepositoryRole",
"Team",
"DeployKey",
"EnterpriseTeam"
"DeployKey"
],
"description": "The type of actor that can bypass a ruleset.\n"
},
@@ -466152,8 +466143,7 @@
"OrganizationAdmin",
"RepositoryRole",
"Team",
"DeployKey",
"EnterpriseTeam"
"DeployKey"
],
"description": "The type of actor that can bypass a ruleset.\n"
},
@@ -467332,8 +467322,7 @@
"OrganizationAdmin",
"RepositoryRole",
"Team",
"DeployKey",
"EnterpriseTeam"
"DeployKey"
]
},
{
@@ -468358,8 +468347,7 @@
"OrganizationAdmin",
"RepositoryRole",
"Team",
"DeployKey",
"EnterpriseTeam"
"DeployKey"
],
"description": "The type of actor that can bypass a ruleset.\n"
},

2
src/rest/lib/config.json
View File

@@ -47,5 +47,5 @@
]
}
},
"sha": "2a29b70c717f70a4afa122ed166a6a885a1d7d77"
"sha": "38baa7aebf29fe927aac6aa0ae769b7a8d3204ca"
}

9
src/webhooks/data/fpt/schema.json
View File

@@ -203349,8 +203349,7 @@
"OrganizationAdmin",
"RepositoryRole",
"Team",
"DeployKey",
"EnterpriseTeam"
"DeployKey"
]
},
{
@@ -204443,8 +204442,7 @@
"OrganizationAdmin",
"RepositoryRole",
"Team",
"DeployKey",
"EnterpriseTeam"
"DeployKey"
]
},
{
@@ -205537,8 +205535,7 @@
"OrganizationAdmin",
"RepositoryRole",
"Team",
"DeployKey",
"EnterpriseTeam"
"DeployKey"
]
},
{

9
src/webhooks/data/ghec/schema.json
View File

@@ -205683,8 +205683,7 @@
"OrganizationAdmin",
"RepositoryRole",
"Team",
"DeployKey",
"EnterpriseTeam"
"DeployKey"
]
},
{
@@ -206777,8 +206776,7 @@
"OrganizationAdmin",
"RepositoryRole",
"Team",
"DeployKey",
"EnterpriseTeam"
"DeployKey"
]
},
{
@@ -207871,8 +207869,7 @@
"OrganizationAdmin",
"RepositoryRole",
"Team",
"DeployKey",
"EnterpriseTeam"
"DeployKey"
]
},
{

9
src/webhooks/data/ghes-3.14/schema.json
View File

@@ -191433,8 +191433,7 @@
"OrganizationAdmin",
"RepositoryRole",
"Team",
"DeployKey",
"EnterpriseTeam"
"DeployKey"
]
},
{
@@ -192450,8 +192449,7 @@
"OrganizationAdmin",
"RepositoryRole",
"Team",
"DeployKey",
"EnterpriseTeam"
"DeployKey"
]
},
{
@@ -193467,8 +193465,7 @@
"OrganizationAdmin",
"RepositoryRole",
"Team",
"DeployKey",
"EnterpriseTeam"
"DeployKey"
]
},
{

2
src/webhooks/lib/config.json
View File

@@ -1,3 +1,3 @@
{
"sha": "2a29b70c717f70a4afa122ed166a6a885a1d7d77"
"sha": "38baa7aebf29fe927aac6aa0ae769b7a8d3204ca"
}