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
@@ -59823,6 +59823,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": [
|
||||
@@ -60077,6 +60119,30 @@
|
||||
"examples": [
|
||||
"\"http://github.blog\""
|
||||
]
|
||||
},
|
||||
"advanced_security_enabled_for_new_repositories": {
|
||||
"type": "boolean",
|
||||
"description": "Whether GitHub Advanced Security is automatically enabled for new repositories.\n\nTo 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 \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request."
|
||||
},
|
||||
"dependabot_alerts_enabled_for_new_repositories": {
|
||||
"type": "boolean",
|
||||
"description": "Whether Dependabot alerts is automatically enabled for new repositories.\n\nTo 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 \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request."
|
||||
},
|
||||
"dependabot_security_updates_enabled_for_new_repositories": {
|
||||
"type": "boolean",
|
||||
"description": "Whether Dependabot security updates is automatically enabled for new repositories.\n\nTo 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 \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request."
|
||||
},
|
||||
"dependency_graph_enabled_for_new_repositories": {
|
||||
"type": "boolean",
|
||||
"description": "Whether dependency graph is automatically enabled for new repositories.\n\nTo 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 \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request."
|
||||
},
|
||||
"secret_scanning_enabled_for_new_repositories": {
|
||||
"type": "boolean",
|
||||
"description": "Whether secret scanning is automatically enabled for new repositories.\n\nTo 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 \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request."
|
||||
},
|
||||
"secret_scanning_push_protection_enabled_for_new_repositories": {
|
||||
"type": "boolean",
|
||||
"description": "Whether secret scanning push protection is automatically enabled for new repositories.\n\nTo 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 \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request."
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -60448,6 +60514,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": [
|
||||
@@ -98496,17 +98604,6 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"302": {
|
||||
"description": "Response if requester is not an organization member",
|
||||
"headers": {
|
||||
"Location": {
|
||||
"example": "https://api.github.com/orgs/github/public_members",
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"422": {
|
||||
"description": "Validation failed",
|
||||
"content": {
|
||||
@@ -143482,6 +143579,78 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/orgs/{org}/{security_product}/{enablement}": {
|
||||
"post": {
|
||||
"summary": "Enable or disable a security feature for an organization",
|
||||
"description": "Enables or disables the specified security feature for all repositories in an organization.\n\nTo 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.\n\nGitHub Apps must have the `organization_administration:write` permission to use this endpoint.\n\nFor more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"",
|
||||
"tags": [
|
||||
"orgs"
|
||||
],
|
||||
"operationId": "orgs/enable-or-disable-security-product-on-all-org-repos",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/rest/reference/orgs#enable-or-disable-security-product-on-all-org-repos"
|
||||
},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "org",
|
||||
"description": "The organization name. The name is not case sensitive.",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "security_product",
|
||||
"in": "path",
|
||||
"description": "The security feature to enable or disable.",
|
||||
"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": "The action to take.\n\n`enable_all` means to enable the specified security feature for all repositories in the organization.\n`disable_all` means to disable the specified security feature for all repositories in the organization.",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"enable_all",
|
||||
"disable_all"
|
||||
]
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"204": {
|
||||
"description": "Action started"
|
||||
},
|
||||
"422": {
|
||||
"description": "The action could not be taken due to an in progress enablement, or a policy is preventing enablement"
|
||||
}
|
||||
},
|
||||
"x-github": {
|
||||
"githubCloudOnly": false,
|
||||
"enabledForGitHubApps": true,
|
||||
"previews": [
|
||||
|
||||
],
|
||||
"category": "orgs",
|
||||
"subcategory": "orgs"
|
||||
}
|
||||
}
|
||||
},
|
||||
"/projects/columns/cards/{card_id}": {
|
||||
"get": {
|
||||
"summary": "Get a project card",
|
||||
@@ -460454,7 +460623,7 @@
|
||||
"/repos/{template_owner}/{template_repo}/generate": {
|
||||
"post": {
|
||||
"summary": "Create a repository using a template",
|
||||
"description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` 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 [Get a repository](https://docs.github.com/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository",
|
||||
"description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` 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 [Get a repository](https://docs.github.com/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository",
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
|
||||
Reference in New Issue
Block a user