Skip to content

Commit f7c3e68

Browse files
timrogerstimrogers
authored
Merge pull request #1489 from github/openapi-update-51f232c5945778c9d38fec405ea62c55619de237a1d8fe44681966cf4b5a376f
Update OpenAPI 3.1 Descriptions
2 parents 3c55ee7 + f6dd9bd commit f7c3e68

File tree

8 files changed

+1016
-0
lines changed

8 files changed

+1016
-0
lines changed

‎descriptions-next/api.github.com/api.github.com.json

Lines changed: 138 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7101,6 +7101,30 @@
71017101
"examples": [
71027102
"\"http://github.blog\""
71037103
]
7104+
},
7105+
"advanced_security_enabled_for_new_repositories": {
7106+
"type": "boolean",
7107+
"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."
7108+
},
7109+
"dependabot_alerts_enabled_for_new_repositories": {
7110+
"type": "boolean",
7111+
"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."
7112+
},
7113+
"dependabot_security_updates_enabled_for_new_repositories": {
7114+
"type": "boolean",
7115+
"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."
7116+
},
7117+
"dependency_graph_enabled_for_new_repositories": {
7118+
"type": "boolean",
7119+
"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."
7120+
},
7121+
"secret_scanning_enabled_for_new_repositories": {
7122+
"type": "boolean",
7123+
"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."
7124+
},
7125+
"secret_scanning_push_protection_enabled_for_new_repositories": {
7126+
"type": "boolean",
7127+
"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."
71047128
}
71057129
}
71067130
},
@@ -17326,6 +17350,48 @@
1732617350
}
1732717351
}
1732817352
},
17353+
"/orgs/{org}/{security_product}/{enablement}": {
17354+
"post": {
17355+
"summary": "Enable or disable a security feature for an organization",
17356+
"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).\"",
17357+
"tags": [
17358+
"orgs"
17359+
],
17360+
"operationId": "orgs/enable-or-disable-security-product-on-all-org-repos",
17361+
"externalDocs": {
17362+
"description": "API method documentation",
17363+
"url": "https://docs.github.com/rest/reference/orgs#enable-or-disable-security-product-on-all-org-repos"
17364+
},
17365+
"parameters": [
17366+
{
17367+
"$ref": "#/components/parameters/org"
17368+
},
17369+
{
17370+
"$ref": "#/components/parameters/security-product"
17371+
},
17372+
{
17373+
"$ref": "#/components/parameters/org-security-product-enablement"
17374+
}
17375+
],
17376+
"responses": {
17377+
"204": {
17378+
"description": "Action started"
17379+
},
17380+
"422": {
17381+
"description": "The action could not be taken due to an in progress enablement, or a policy is preventing enablement"
17382+
}
17383+
},
17384+
"x-github": {
17385+
"githubCloudOnly": false,
17386+
"enabledForGitHubApps": true,
17387+
"previews": [
17388+
17389+
],
17390+
"category": "orgs",
17391+
"subcategory": "orgs"
17392+
}
17393+
}
17394+
},
1732917395
"/projects/columns/cards/{card_id}": {
1733017396
"get": {
1733117397
"summary": "Get a project card",
@@ -66807,6 +66873,48 @@
6680766873
"updated_at": {
6680866874
"type": "string",
6680966875
"format": "date-time"
66876+
},
66877+
"advanced_security_enabled_for_new_repositories": {
66878+
"type": "boolean",
66879+
"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.",
66880+
"examples": [
66881+
false
66882+
]
66883+
},
66884+
"dependabot_alerts_enabled_for_new_repositories": {
66885+
"type": "boolean",
66886+
"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.",
66887+
"examples": [
66888+
false
66889+
]
66890+
},
66891+
"dependabot_security_updates_enabled_for_new_repositories": {
66892+
"type": "boolean",
66893+
"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.",
66894+
"examples": [
66895+
false
66896+
]
66897+
},
66898+
"dependency_graph_enabled_for_new_repositories": {
66899+
"type": "boolean",
66900+
"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.",
66901+
"examples": [
66902+
false
66903+
]
66904+
},
66905+
"secret_scanning_enabled_for_new_repositories": {
66906+
"type": "boolean",
66907+
"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.",
66908+
"examples": [
66909+
false
66910+
]
66911+
},
66912+
"secret_scanning_push_protection_enabled_for_new_repositories": {
66913+
"type": "boolean",
66914+
"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.",
66915+
"examples": [
66916+
false
66917+
]
6681066918
}
6681166919
},
6681266920
"required": [
@@ -114886,6 +114994,36 @@
114886114994
"type": "integer"
114887114995
}
114888114996
},
114997+
"security-product": {
114998+
"name": "security_product",
114999+
"in": "path",
115000+
"description": "The security feature to enable or disable.",
115001+
"required": true,
115002+
"schema": {
115003+
"type": "string",
115004+
"enum": [
115005+
"dependency_graph",
115006+
"dependabot_alerts",
115007+
"dependabot_security_updates",
115008+
"advanced_security",
115009+
"secret_scanning",
115010+
"secret_scanning_push_protection"
115011+
]
115012+
}
115013+
},
115014+
"org-security-product-enablement": {
115015+
"name": "enablement",
115016+
"in": "path",
115017+
"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.",
115018+
"required": true,
115019+
"schema": {
115020+
"type": "string",
115021+
"enum": [
115022+
"enable_all",
115023+
"disable_all"
115024+
]
115025+
}
115026+
},
114889115027
"card-id": {
114890115028
"name": "card_id",
114891115029
"description": "The unique identifier of the card.",

0 commit comments

Comments
 (0)