Update OpenAPI Descriptions (#30417)
Co-authored-by: github-openapi-bot <github-openapi-bot@users.noreply.github.com>
This commit is contained in:
github-openapi-bot
committed by
GitHub
GitHub
parent
19277524c2
commit
0e8b6d2ed5
@@ -391924,6 +391924,48 @@
|
||||
"updated_at": {
|
||||
"type": "string",
|
||||
"format": "date-time"
|
||||
},
|
||||
"advanced_security_enabled_for_new_repositories": {
|
||||
"type": "boolean",
|
||||
"description": "Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.",
|
||||
"examples": [
|
||||
false
|
||||
]
|
||||
},
|
||||
"dependabot_alerts_enabled_for_new_repositories": {
|
||||
"type": "boolean",
|
||||
"description": "Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to\nthis organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.",
|
||||
"examples": [
|
||||
false
|
||||
]
|
||||
},
|
||||
"dependabot_security_updates_enabled_for_new_repositories": {
|
||||
"type": "boolean",
|
||||
"description": "Whether dependabot security updates are automatically enabled for new repositories and repositories transferred\nto this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.",
|
||||
"examples": [
|
||||
false
|
||||
]
|
||||
},
|
||||
"dependency_graph_enabled_for_new_repositories": {
|
||||
"type": "boolean",
|
||||
"description": "Whether dependency graph is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.",
|
||||
"examples": [
|
||||
false
|
||||
]
|
||||
},
|
||||
"secret_scanning_enabled_for_new_repositories": {
|
||||
"type": "boolean",
|
||||
"description": "Whether secret scanning is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.",
|
||||
"examples": [
|
||||
false
|
||||
]
|
||||
},
|
||||
"secret_scanning_push_protection_enabled_for_new_repositories": {
|
||||
"type": "boolean",
|
||||
"description": "Whether secret scanning push protection is automatically enabled for new repositories and repositories\ntransferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.",
|
||||
"examples": [
|
||||
false
|
||||
]
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
@@ -392127,6 +392169,42 @@
|
||||
"name": "blog",
|
||||
"in": "body",
|
||||
"description": ""
|
||||
},
|
||||
{
|
||||
"type": "boolean",
|
||||
"name": "advanced_security_enabled_for_new_repositories",
|
||||
"in": "body",
|
||||
"description": "<p>Whether GitHub Advanced Security is automatically enabled for new repositories.</p>\n<p>To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"<a href=\"https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization\">Managing security managers in your organization</a>.\"</p>\n<p>You can check which security and analysis features are currently enabled by using a <code>GET /orgs/{org}</code> request.</p>"
|
||||
},
|
||||
{
|
||||
"type": "boolean",
|
||||
"name": "dependabot_alerts_enabled_for_new_repositories",
|
||||
"in": "body",
|
||||
"description": "<p>Whether Dependabot alerts is automatically enabled for new repositories.</p>\n<p>To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"<a href=\"https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization\">Managing security managers in your organization</a>.\"</p>\n<p>You can check which security and analysis features are currently enabled by using a <code>GET /orgs/{org}</code> request.</p>"
|
||||
},
|
||||
{
|
||||
"type": "boolean",
|
||||
"name": "dependabot_security_updates_enabled_for_new_repositories",
|
||||
"in": "body",
|
||||
"description": "<p>Whether Dependabot security updates is automatically enabled for new repositories.</p>\n<p>To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"<a href=\"https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization\">Managing security managers in your organization</a>.\"</p>\n<p>You can check which security and analysis features are currently enabled by using a <code>GET /orgs/{org}</code> request.</p>"
|
||||
},
|
||||
{
|
||||
"type": "boolean",
|
||||
"name": "dependency_graph_enabled_for_new_repositories",
|
||||
"in": "body",
|
||||
"description": "<p>Whether dependency graph is automatically enabled for new repositories.</p>\n<p>To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"<a href=\"https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization\">Managing security managers in your organization</a>.\"</p>\n<p>You can check which security and analysis features are currently enabled by using a <code>GET /orgs/{org}</code> request.</p>"
|
||||
},
|
||||
{
|
||||
"type": "boolean",
|
||||
"name": "secret_scanning_enabled_for_new_repositories",
|
||||
"in": "body",
|
||||
"description": "<p>Whether secret scanning is automatically enabled for new repositories.</p>\n<p>To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"<a href=\"https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization\">Managing security managers in your organization</a>.\"</p>\n<p>You can check which security and analysis features are currently enabled by using a <code>GET /orgs/{org}</code> request.</p>"
|
||||
},
|
||||
{
|
||||
"type": "boolean",
|
||||
"name": "secret_scanning_push_protection_enabled_for_new_repositories",
|
||||
"in": "body",
|
||||
"description": "<p>Whether secret scanning push protection is automatically enabled for new repositories.</p>\n<p>To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"<a href=\"https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization\">Managing security managers in your organization</a>.\"</p>\n<p>You can check which security and analysis features are currently enabled by using a <code>GET /orgs/{org}</code> request.</p>"
|
||||
}
|
||||
],
|
||||
"enabledForGitHubApps": true,
|
||||
@@ -392555,6 +392633,48 @@
|
||||
"updated_at": {
|
||||
"type": "string",
|
||||
"format": "date-time"
|
||||
},
|
||||
"advanced_security_enabled_for_new_repositories": {
|
||||
"type": "boolean",
|
||||
"description": "Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.",
|
||||
"examples": [
|
||||
false
|
||||
]
|
||||
},
|
||||
"dependabot_alerts_enabled_for_new_repositories": {
|
||||
"type": "boolean",
|
||||
"description": "Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to\nthis organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.",
|
||||
"examples": [
|
||||
false
|
||||
]
|
||||
},
|
||||
"dependabot_security_updates_enabled_for_new_repositories": {
|
||||
"type": "boolean",
|
||||
"description": "Whether dependabot security updates are automatically enabled for new repositories and repositories transferred\nto this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.",
|
||||
"examples": [
|
||||
false
|
||||
]
|
||||
},
|
||||
"dependency_graph_enabled_for_new_repositories": {
|
||||
"type": "boolean",
|
||||
"description": "Whether dependency graph is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.",
|
||||
"examples": [
|
||||
false
|
||||
]
|
||||
},
|
||||
"secret_scanning_enabled_for_new_repositories": {
|
||||
"type": "boolean",
|
||||
"description": "Whether secret scanning is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.",
|
||||
"examples": [
|
||||
false
|
||||
]
|
||||
},
|
||||
"secret_scanning_push_protection_enabled_for_new_repositories": {
|
||||
"type": "boolean",
|
||||
"description": "Whether secret scanning push protection is automatically enabled for new repositories and repositories\ntransferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.",
|
||||
"examples": [
|
||||
false
|
||||
]
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
@@ -394138,6 +394258,87 @@
|
||||
],
|
||||
"subcategory": "orgs"
|
||||
},
|
||||
{
|
||||
"serverUrl": "https://api.github.com",
|
||||
"verb": "post",
|
||||
"requestPath": "/orgs/{org}/{security_product}/{enablement}",
|
||||
"title": "Enable or disable a security feature for an organization",
|
||||
"category": "orgs",
|
||||
"subcategory": "orgs",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "org",
|
||||
"description": "<p>The organization name. The name is not case sensitive.</p>",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "security_product",
|
||||
"in": "path",
|
||||
"description": "<p>The security feature to enable or disable.</p>",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"dependency_graph",
|
||||
"dependabot_alerts",
|
||||
"dependabot_security_updates",
|
||||
"advanced_security",
|
||||
"secret_scanning",
|
||||
"secret_scanning_push_protection"
|
||||
]
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "enablement",
|
||||
"in": "path",
|
||||
"description": "<p>The action to take.</p>\n<p><code>enable_all</code> means to enable the specified security feature for all repositories in the organization.\n<code>disable_all</code> means to disable the specified security feature for all repositories in the organization.</p>",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"enable_all",
|
||||
"disable_all"
|
||||
]
|
||||
}
|
||||
}
|
||||
],
|
||||
"bodyParameters": [],
|
||||
"enabledForGitHubApps": true,
|
||||
"codeExamples": [
|
||||
{
|
||||
"key": "default",
|
||||
"request": {
|
||||
"description": "Example",
|
||||
"acceptHeader": "application/vnd.github.v3+json",
|
||||
"parameters": {
|
||||
"org": "ORG",
|
||||
"security_product": "SECURITY_PRODUCT",
|
||||
"enablement": "ENABLEMENT"
|
||||
}
|
||||
},
|
||||
"response": {
|
||||
"statusCode": "204",
|
||||
"description": "<p>Action started</p>"
|
||||
}
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Enables or disables the specified security feature for all repositories in an organization.</p>\n<p>To use this endpoint, you must be an organization owner or be member of a team with the security manager role.\nA token with the 'write:org' scope is also required.</p>\n<p>GitHub Apps must have the <code>organization_administration:write</code> permission to use this endpoint.</p>\n<p>For more information, see \"<a href=\"https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization\">Managing security managers in your organization</a>.\"</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "204",
|
||||
"description": "<p>Action started</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "422",
|
||||
"description": "<p>The action could not be taken due to an in progress enablement, or a policy is preventing enablement</p>"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"serverUrl": "https://api.github.com",
|
||||
"verb": "get",
|
||||
@@ -396658,10 +396859,6 @@
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "302",
|
||||
"description": "<p>Response if requester is not an organization member</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "422",
|
||||
"description": "<p>Validation failed</p>"
|
||||
@@ -504889,7 +505086,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Creates a new repository using a repository template. Use the <code>template_owner</code> and <code>template_repo</code> route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the <a href=\"https://docs.github.com/rest/reference/repos#get-a-repository\">Get a repository</a> endpoint and check that the <code>is_template</code> key is <code>true</code>.</p>\n<p><strong>OAuth scope requirements</strong></p>\n<p>When using <a href=\"https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">OAuth</a>, authorizations must include:</p>\n<ul>\n<li><code>public_repo</code> scope or <code>repo</code> scope to create a public repository. Note: For GitHub AE, use <code>repo</code> scope to create an internal repository.</li>\n<li><code>repo</code> scope to create a private repository</li>\n</ul>",
|
||||
"descriptionHTML": "<p>Creates a new repository using a repository template. Use the <code>template_owner</code> and <code>template_repo</code> route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the <a href=\"https://docs.github.com/rest/reference/repos#get-a-repository\">Get a repository</a> endpoint and check that the <code>is_template</code> key is <code>true</code>.</p>\n<p><strong>OAuth scope requirements</strong></p>\n<p>When using <a href=\"https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">OAuth</a>, authorizations must include:</p>\n<ul>\n<li><code>public_repo</code> scope or <code>repo</code> scope to create a public repository. Note: For GitHub AE, use <code>repo</code> scope to create an internal repository.</li>\n<li><code>repo</code> scope to create a private repository</li>\n</ul>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "201",
|
||||
|
||||
Reference in New Issue
Block a user