Skip to content

repo sync #22353

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 29, 2022
Merged

repo sync #22353

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
58322e7
Update OpenAPI Descriptions (#33060)
github-openapi-bot Nov 29, 2022
9d80b97
Merge branch 'main' into repo-sync
Octomerger Nov 29, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
345 changes: 345 additions & 0 deletions lib/rest/static/decorated/api.github.com.2022-11-28.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -468766,6 +468766,265 @@
},
"secret-scanning": {
"secret-scanning": [
{
"serverUrl": "https://api.github.com",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/code_security_and_analysis",
"title": "Get code security and analysis settings for an enterprise",
"category": "secret-scanning",
"parameters": [
{
"name": "enterprise",
"description": "<p>The slug version of the enterprise name. You can also substitute this value with the enterprise id.</p>",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"bodyParameters": [],
"enabledForGitHubApps": false,
"codeExamples": [
{
"key": "default",
"request": {
"description": "Example",
"acceptHeader": "application/vnd.github.v3+json",
"parameters": {
"enterprise": "ENTERPRISE"
}
},
"response": {
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response</p>",
"example": {
"advanced_security_enabled_for_new_repositories": true,
"secret_scanning_enabled_for_new_repositories": true,
"secret_scanning_push_protection_enabled_for_new_repositories": true,
"secret_scanning_push_protection_custom_link_enabled": true,
"secret_scanning_push_protection_custom_link": "https://github.com/test-org/test-repo/blob/main/README.md"
},
"schema": {
"title": "Enterprise Security Analysis Settings",
"type": "object",
"properties": {
"advanced_security_enabled_for_new_repositories": {
"type": "boolean",
"description": "Whether GitHub advanced security is automatically enabled for new repositories and repositories transferred to\nthis enterprise.",
"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\nenterprise.",
"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 enterprise.",
"examples": [
false
]
},
"secret_scanning_push_protection_custom_link_enabled": {
"type": "boolean",
"description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.",
"examples": [
false
]
},
"secret_scanning_push_protection_custom_link": {
"type": [
"string",
"null"
],
"description": "An optional URL string to display to contributors who are blocked from pushing a secret.",
"examples": [
"https://github.com/test-org/test-repo/blob/main/README.md"
]
}
},
"required": [
"advanced_security_enabled_for_new_repositories",
"secret_scanning_enabled_for_new_repositories",
"secret_scanning_push_protection_enabled_for_new_repositories"
]
}
}
}
],
"previews": [],
"descriptionHTML": "<p>Gets code security and analysis settings for the specified enterprise.\nTo use this endpoint, you must be an administrator of the enterprise.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
},
{
"httpStatusCode": "404",
"description": "<p>Resource not found</p>"
},
{
"httpStatusCode": "503",
"description": "<p>Service unavailable</p>"
}
],
"subcategory": "secret-scanning"
},
{
"serverUrl": "https://api.github.com",
"verb": "patch",
"requestPath": "/enterprises/{enterprise}/code_security_and_analysis",
"title": "Update security and analysis settings for new repositories in an enterprise",
"category": "secret-scanning",
"parameters": [
{
"name": "enterprise",
"description": "<p>The slug version of the enterprise name. You can also substitute this value with the enterprise id.</p>",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"bodyParameters": [
{
"type": "boolean",
"name": "advanced_security_enabled_for_new_repositories",
"in": "body",
"description": "<p>Whether GitHub Advanced Security is automatically enabled for new repositories. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest/get-started/learning-about-github/about-github-advanced-security\">About GitHub Advanced Security</a>\".</p>"
},
{
"type": "boolean",
"name": "secret_scanning_enabled_for_new_repositories",
"in": "body",
"description": "<p>Whether secret scanning is automatically enabled for new repositories. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/about-secret-scanning\">About secret scanning</a>\".</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. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/protecting-pushes-with-secret-scanning\">Protecting pushes with secret scanning</a>\".</p>"
},
{
"type": "boolean",
"name": "secret_scanning_push_protection_custom_link_enabled",
"in": "body",
"description": "<p>Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/protecting-pushes-with-secret-scanning\">Protecting pushes with secret scanning</a>\".</p>"
},
{
"type": "string",
"name": "secret_scanning_push_protection_custom_link",
"in": "body",
"description": "<p>If <code>secret_scanning_push_protection_custom_link_enabled</code> is true, the URL that will be displayed to contributors who are blocked from pushing a secret. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/protecting-pushes-with-secret-scanning\">Protecting pushes with secret scanning</a>\".</p>"
}
],
"enabledForGitHubApps": false,
"codeExamples": [
{
"key": "default",
"request": {
"contentType": "application/json",
"description": "Example",
"acceptHeader": "application/vnd.github.v3+json",
"bodyParameters": {
"advanced_security_enabled_for_new_repositories": true,
"secret_scanning_enabled_for_new_repositories": true,
"secret_scanning_push_protection_enabled_for_new_repositories": true,
"secret_scanning_push_protection_custom_link_enabled": true,
"secret_scanning_push_protection_custom_link": "https://github.com/test-org/test-repo/blob/main/README.md"
},
"parameters": {
"enterprise": "ENTERPRISE"
}
},
"response": {
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response</p>",
"example": {
"advanced_security_enabled_for_new_repositories": true,
"secret_scanning_enabled_for_new_repositories": true,
"secret_scanning_push_protection_enabled_for_new_repositories": true,
"secret_scanning_push_protection_custom_link_enabled": true,
"secret_scanning_push_protection_custom_link": "https://github.com/test-org/test-repo/blob/main/README.md"
},
"schema": {
"title": "Enterprise Security Analysis Settings",
"type": "object",
"properties": {
"advanced_security_enabled_for_new_repositories": {
"type": "boolean",
"description": "Whether GitHub advanced security is automatically enabled for new repositories and repositories transferred to\nthis enterprise.",
"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\nenterprise.",
"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 enterprise.",
"examples": [
false
]
},
"secret_scanning_push_protection_custom_link_enabled": {
"type": "boolean",
"description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.",
"examples": [
false
]
},
"secret_scanning_push_protection_custom_link": {
"type": [
"string",
"null"
],
"description": "An optional URL string to display to contributors who are blocked from pushing a secret.",
"examples": [
"https://github.com/test-org/test-repo/blob/main/README.md"
]
}
},
"required": [
"advanced_security_enabled_for_new_repositories",
"secret_scanning_enabled_for_new_repositories",
"secret_scanning_push_protection_enabled_for_new_repositories"
]
}
}
}
],
"previews": [],
"descriptionHTML": "<p>Updates the settings for advanced security, secret scanning, and push protection for new repositories in an enterprise.\nTo use this endpoint, you must be an administrator of the enterprise, and you must use an access token with the <code>admin:enterprise</code> scope.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
},
{
"httpStatusCode": "404",
"description": "<p>Resource not found</p>"
},
{
"httpStatusCode": "503",
"description": "<p>Service unavailable</p>"
}
],
"subcategory": "secret-scanning"
},
{
"serverUrl": "https://api.github.com",
"verb": "get",
Expand Down Expand Up @@ -470108,6 +470367,92 @@
],
"subcategory": "secret-scanning"
},
{
"serverUrl": "https://api.github.com",
"verb": "post",
"requestPath": "/enterprises/{enterprise}/{security_product}/{enablement}",
"title": "Enable or disable security features for an enterprise",
"category": "secret-scanning",
"parameters": [
{
"name": "enterprise",
"description": "<p>The slug version of the enterprise name. You can also substitute this value with the enterprise id.</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": [
"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 enterprise.\n<code>disable_all</code> means to disable the specified security feature for all repositories in the enterprise.</p>",
"required": true,
"schema": {
"type": "string",
"enum": [
"enable_all",
"disable_all"
]
}
}
],
"bodyParameters": [],
"enabledForGitHubApps": false,
"codeExamples": [
{
"key": "default",
"request": {
"description": "Example",
"acceptHeader": "application/vnd.github.v3+json",
"parameters": {
"enterprise": "ENTERPRISE",
"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 enterprise.</p>\n<p>To use this endpoint, you must be an administrator of the enterprise, and you must use an access token with the <code>admin:enterprise</code> scope.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>Action started</p>"
},
{
"httpStatusCode": "404",
"description": "<p>Resource not found</p>"
},
{
"httpStatusCode": "422",
"description": "<p>The action could not be taken due to an in progress enablement, or a policy is preventing enablement</p>"
},
{
"httpStatusCode": "503",
"description": "<p>Service unavailable</p>"
}
],
"subcategory": "secret-scanning"
},
{
"serverUrl": "https://api.github.com",
"verb": "get",
Expand Down
Loading