From 99a9ecf0ffe87c95446193199a18d2be215865c2 Mon Sep 17 00:00:00 2001 From: Octokit Bot <33075676+octokitbot@users.noreply.github.com> Date: Mon, 22 Apr 2024 21:56:05 +0000 Subject: [PATCH] WIP --- cache/api.github.com.json | 757 ++++------- cache/ghec.json | 757 ++++------- cache/ghes-3.10.json | 659 +++------- cache/ghes-3.11.json | 757 ++++------- cache/ghes-3.12.json | 1111 +++++++++-------- cache/ghes-3.9.json | 643 +++------- cache/github.ae.json | 2 +- packages/openapi-types-ghec/package.json | 2 +- packages/openapi-types-ghec/types.d.ts | 274 ++-- packages/openapi-types-ghes-3.10/package.json | 2 +- packages/openapi-types-ghes-3.10/types.d.ts | 242 +--- packages/openapi-types-ghes-3.11/package.json | 2 +- packages/openapi-types-ghes-3.11/types.d.ts | 274 ++-- packages/openapi-types-ghes-3.12/package.json | 2 +- packages/openapi-types-ghes-3.12/types.d.ts | 338 ++--- packages/openapi-types-ghes-3.9/package.json | 2 +- packages/openapi-types-ghes-3.9/types.d.ts | 234 +--- packages/openapi-types-github.ae/package.json | 2 +- packages/openapi-types/package.json | 2 +- packages/openapi-types/types.d.ts | 274 ++-- 20 files changed, 2016 insertions(+), 4320 deletions(-) diff --git a/cache/api.github.com.json b/cache/api.github.com.json index b433a3ac6..7f8db03e0 100644 --- a/cache/api.github.com.json +++ b/cache/api.github.com.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "16.2.0", + "version": "16.3.0", "title": "GitHub's official OpenAPI spec + Octokit extension", "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs", "license": { @@ -88026,6 +88026,56 @@ "swift" ] }, + "vulnerability": { + "description": "A vulnerability describing the product and its affected versions within a GitHub Security Advisory.", + "type": "object", + "properties": { + "package": { + "description": "The name of the package affected by the vulnerability.", + "type": "object", + "nullable": true, + "properties": { + "ecosystem": { + "$ref": "#/components/schemas/security-advisory-ecosystems" + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "nullable": true + } + }, + "required": [ + "ecosystem", + "name" + ] + }, + "vulnerable_version_range": { + "type": "string", + "description": "The range of the package versions affected by the vulnerability.", + "nullable": true + }, + "first_patched_version": { + "type": "string", + "description": "The package version that resolves the vulnerability.", + "nullable": true + }, + "vulnerable_functions": { + "type": "array", + "description": "The functions in the package that are affected by the vulnerability.", + "nullable": true, + "readOnly": true, + "items": { + "type": "string" + } + } + }, + "required": [ + "package", + "vulnerable_version_range", + "first_patched_version", + "vulnerable_functions" + ] + }, "simple-user": { "title": "Simple User", "description": "A GitHub user.", @@ -88304,53 +88354,7 @@ "description": "The products and respective version ranges affected by the advisory.", "nullable": true, "items": { - "type": "object", - "properties": { - "package": { - "description": "The name of the package affected by the vulnerability.", - "type": "object", - "nullable": true, - "properties": { - "ecosystem": { - "$ref": "#/components/schemas/security-advisory-ecosystems" - }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "nullable": true - } - }, - "required": [ - "ecosystem", - "name" - ] - }, - "vulnerable_version_range": { - "type": "string", - "description": "The range of the package versions affected by the vulnerability.", - "nullable": true - }, - "first_patched_version": { - "type": "string", - "description": "The package version that resolve the vulnerability.", - "nullable": true - }, - "vulnerable_functions": { - "type": "array", - "description": "The functions in the package that are affected by the vulnerability.", - "nullable": true, - "readOnly": true, - "items": { - "type": "string" - } - } - }, - "required": [ - "package", - "vulnerable_version_range", - "first_patched_version", - "vulnerable_functions" - ] + "$ref": "#/components/schemas/vulnerability" } }, "cvss": { @@ -120302,6 +120306,171 @@ "url" ] }, + "webhooks_rule": { + "title": "branch protection rule", + "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.", + "type": "object", + "properties": { + "admin_enforced": { + "type": "boolean" + }, + "allow_deletions_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "allow_force_pushes_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "authorized_actor_names": { + "type": "array", + "items": { + "type": "string" + } + }, + "authorized_actors_only": { + "type": "boolean" + }, + "authorized_dismissal_actors_only": { + "type": "boolean" + }, + "create_protected": { + "type": "boolean" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "dismiss_stale_reviews_on_push": { + "type": "boolean" + }, + "id": { + "type": "integer" + }, + "ignore_approvals_from_contributors": { + "type": "boolean" + }, + "linear_history_requirement_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "merge_queue_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "name": { + "type": "string" + }, + "pull_request_reviews_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "repository_id": { + "type": "integer" + }, + "require_code_owner_review": { + "type": "boolean" + }, + "require_last_push_approval": { + "description": "Whether the most recent push must be approved by someone other than the person who pushed it", + "type": "boolean" + }, + "required_approving_review_count": { + "type": "integer" + }, + "required_conversation_resolution_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "required_deployments_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "required_status_checks": { + "type": "array", + "items": { + "type": "string" + } + }, + "required_status_checks_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "signature_requirement_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "strict_required_status_checks_policy": { + "type": "boolean" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "id", + "repository_id", + "name", + "created_at", + "updated_at", + "pull_request_reviews_enforcement_level", + "required_approving_review_count", + "dismiss_stale_reviews_on_push", + "require_code_owner_review", + "authorized_dismissal_actors_only", + "ignore_approvals_from_contributors", + "required_status_checks", + "required_status_checks_enforcement_level", + "strict_required_status_checks_policy", + "signature_requirement_enforcement_level", + "linear_history_requirement_enforcement_level", + "admin_enforced", + "allow_force_pushes_enforcement_level", + "allow_deletions_enforcement_level", + "merge_queue_enforcement_level", + "required_deployments_enforcement_level", + "required_conversation_resolution_level", + "authorized_actors_only", + "authorized_actor_names" + ] + }, "simple-check-suite": { "description": "A suite of checks performed on the code of a given code change", "type": "object", @@ -122435,169 +122604,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "rule": { - "title": "branch protection rule", - "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.", - "type": "object", - "properties": { - "admin_enforced": { - "type": "boolean" - }, - "allow_deletions_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "allow_force_pushes_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "authorized_actor_names": { - "type": "array", - "items": { - "type": "string" - } - }, - "authorized_actors_only": { - "type": "boolean" - }, - "authorized_dismissal_actors_only": { - "type": "boolean" - }, - "create_protected": { - "type": "boolean" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "dismiss_stale_reviews_on_push": { - "type": "boolean" - }, - "id": { - "type": "integer" - }, - "ignore_approvals_from_contributors": { - "type": "boolean" - }, - "linear_history_requirement_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "merge_queue_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "name": { - "type": "string" - }, - "pull_request_reviews_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "repository_id": { - "type": "integer" - }, - "require_code_owner_review": { - "type": "boolean" - }, - "require_last_push_approval": { - "description": "Whether the most recent push must be approved by someone other than the person who pushed it", - "type": "boolean" - }, - "required_approving_review_count": { - "type": "integer" - }, - "required_conversation_resolution_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "required_deployments_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "required_status_checks": { - "type": "array", - "items": { - "type": "string" - } - }, - "required_status_checks_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "signature_requirement_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "strict_required_status_checks_policy": { - "type": "boolean" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "repository_id", - "name", - "created_at", - "updated_at", - "pull_request_reviews_enforcement_level", - "required_approving_review_count", - "dismiss_stale_reviews_on_push", - "require_code_owner_review", - "authorized_dismissal_actors_only", - "ignore_approvals_from_contributors", - "required_status_checks", - "required_status_checks_enforcement_level", - "strict_required_status_checks_policy", - "signature_requirement_enforcement_level", - "linear_history_requirement_enforcement_level", - "admin_enforced", - "allow_force_pushes_enforcement_level", - "allow_deletions_enforcement_level", - "merge_queue_enforcement_level", - "required_deployments_enforcement_level", - "required_conversation_resolution_level", - "authorized_actors_only", - "authorized_actor_names" - ] + "$ref": "#/components/schemas/webhooks_rule" }, "sender": { "$ref": "#/components/schemas/simple-user-webhooks" @@ -122633,169 +122640,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "rule": { - "title": "branch protection rule", - "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.", - "type": "object", - "properties": { - "admin_enforced": { - "type": "boolean" - }, - "allow_deletions_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "allow_force_pushes_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "authorized_actor_names": { - "type": "array", - "items": { - "type": "string" - } - }, - "authorized_actors_only": { - "type": "boolean" - }, - "authorized_dismissal_actors_only": { - "type": "boolean" - }, - "create_protected": { - "type": "boolean" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "dismiss_stale_reviews_on_push": { - "type": "boolean" - }, - "id": { - "type": "integer" - }, - "ignore_approvals_from_contributors": { - "type": "boolean" - }, - "linear_history_requirement_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "merge_queue_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "name": { - "type": "string" - }, - "pull_request_reviews_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "repository_id": { - "type": "integer" - }, - "require_code_owner_review": { - "type": "boolean" - }, - "require_last_push_approval": { - "description": "Whether the most recent push must be approved by someone other than the person who pushed it", - "type": "boolean" - }, - "required_approving_review_count": { - "type": "integer" - }, - "required_conversation_resolution_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "required_deployments_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "required_status_checks": { - "type": "array", - "items": { - "type": "string" - } - }, - "required_status_checks_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "signature_requirement_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "strict_required_status_checks_policy": { - "type": "boolean" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "repository_id", - "name", - "created_at", - "updated_at", - "pull_request_reviews_enforcement_level", - "required_approving_review_count", - "dismiss_stale_reviews_on_push", - "require_code_owner_review", - "authorized_dismissal_actors_only", - "ignore_approvals_from_contributors", - "required_status_checks", - "required_status_checks_enforcement_level", - "strict_required_status_checks_policy", - "signature_requirement_enforcement_level", - "linear_history_requirement_enforcement_level", - "admin_enforced", - "allow_force_pushes_enforcement_level", - "allow_deletions_enforcement_level", - "merge_queue_enforcement_level", - "required_deployments_enforcement_level", - "required_conversation_resolution_level", - "authorized_actors_only", - "authorized_actor_names" - ] + "$ref": "#/components/schemas/webhooks_rule" }, "sender": { "$ref": "#/components/schemas/simple-user-webhooks" @@ -122933,169 +122778,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "rule": { - "title": "branch protection rule", - "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.", - "type": "object", - "properties": { - "admin_enforced": { - "type": "boolean" - }, - "allow_deletions_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "allow_force_pushes_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "authorized_actor_names": { - "type": "array", - "items": { - "type": "string" - } - }, - "authorized_actors_only": { - "type": "boolean" - }, - "authorized_dismissal_actors_only": { - "type": "boolean" - }, - "create_protected": { - "type": "boolean" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "dismiss_stale_reviews_on_push": { - "type": "boolean" - }, - "id": { - "type": "integer" - }, - "ignore_approvals_from_contributors": { - "type": "boolean" - }, - "linear_history_requirement_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "merge_queue_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "name": { - "type": "string" - }, - "pull_request_reviews_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "repository_id": { - "type": "integer" - }, - "require_code_owner_review": { - "type": "boolean" - }, - "require_last_push_approval": { - "description": "Whether the most recent push must be approved by someone other than the person who pushed it", - "type": "boolean" - }, - "required_approving_review_count": { - "type": "integer" - }, - "required_conversation_resolution_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "required_deployments_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "required_status_checks": { - "type": "array", - "items": { - "type": "string" - } - }, - "required_status_checks_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "signature_requirement_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "strict_required_status_checks_policy": { - "type": "boolean" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "repository_id", - "name", - "created_at", - "updated_at", - "pull_request_reviews_enforcement_level", - "required_approving_review_count", - "dismiss_stale_reviews_on_push", - "require_code_owner_review", - "authorized_dismissal_actors_only", - "ignore_approvals_from_contributors", - "required_status_checks", - "required_status_checks_enforcement_level", - "strict_required_status_checks_policy", - "signature_requirement_enforcement_level", - "linear_history_requirement_enforcement_level", - "admin_enforced", - "allow_force_pushes_enforcement_level", - "allow_deletions_enforcement_level", - "merge_queue_enforcement_level", - "required_deployments_enforcement_level", - "required_conversation_resolution_level", - "authorized_actors_only", - "authorized_actor_names" - ] + "$ref": "#/components/schemas/webhooks_rule" }, "sender": { "$ref": "#/components/schemas/simple-user-webhooks" diff --git a/cache/ghec.json b/cache/ghec.json index c3fa110b0..bed462893 100644 --- a/cache/ghec.json +++ b/cache/ghec.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "16.2.0", + "version": "16.3.0", "title": "GitHub's official OpenAPI spec + Octokit extension", "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs", "license": { @@ -95090,6 +95090,56 @@ "swift" ] }, + "vulnerability": { + "description": "A vulnerability describing the product and its affected versions within a GitHub Security Advisory.", + "type": "object", + "properties": { + "package": { + "description": "The name of the package affected by the vulnerability.", + "type": "object", + "nullable": true, + "properties": { + "ecosystem": { + "$ref": "#/components/schemas/security-advisory-ecosystems" + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "nullable": true + } + }, + "required": [ + "ecosystem", + "name" + ] + }, + "vulnerable_version_range": { + "type": "string", + "description": "The range of the package versions affected by the vulnerability.", + "nullable": true + }, + "first_patched_version": { + "type": "string", + "description": "The package version that resolves the vulnerability.", + "nullable": true + }, + "vulnerable_functions": { + "type": "array", + "description": "The functions in the package that are affected by the vulnerability.", + "nullable": true, + "readOnly": true, + "items": { + "type": "string" + } + } + }, + "required": [ + "package", + "vulnerable_version_range", + "first_patched_version", + "vulnerable_functions" + ] + }, "simple-user": { "title": "Simple User", "description": "A GitHub user.", @@ -95368,53 +95418,7 @@ "description": "The products and respective version ranges affected by the advisory.", "nullable": true, "items": { - "type": "object", - "properties": { - "package": { - "description": "The name of the package affected by the vulnerability.", - "type": "object", - "nullable": true, - "properties": { - "ecosystem": { - "$ref": "#/components/schemas/security-advisory-ecosystems" - }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "nullable": true - } - }, - "required": [ - "ecosystem", - "name" - ] - }, - "vulnerable_version_range": { - "type": "string", - "description": "The range of the package versions affected by the vulnerability.", - "nullable": true - }, - "first_patched_version": { - "type": "string", - "description": "The package version that resolve the vulnerability.", - "nullable": true - }, - "vulnerable_functions": { - "type": "array", - "description": "The functions in the package that are affected by the vulnerability.", - "nullable": true, - "readOnly": true, - "items": { - "type": "string" - } - } - }, - "required": [ - "package", - "vulnerable_version_range", - "first_patched_version", - "vulnerable_functions" - ] + "$ref": "#/components/schemas/vulnerability" } }, "cvss": { @@ -129664,6 +129668,171 @@ "url" ] }, + "webhooks_rule": { + "title": "branch protection rule", + "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.", + "type": "object", + "properties": { + "admin_enforced": { + "type": "boolean" + }, + "allow_deletions_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "allow_force_pushes_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "authorized_actor_names": { + "type": "array", + "items": { + "type": "string" + } + }, + "authorized_actors_only": { + "type": "boolean" + }, + "authorized_dismissal_actors_only": { + "type": "boolean" + }, + "create_protected": { + "type": "boolean" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "dismiss_stale_reviews_on_push": { + "type": "boolean" + }, + "id": { + "type": "integer" + }, + "ignore_approvals_from_contributors": { + "type": "boolean" + }, + "linear_history_requirement_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "merge_queue_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "name": { + "type": "string" + }, + "pull_request_reviews_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "repository_id": { + "type": "integer" + }, + "require_code_owner_review": { + "type": "boolean" + }, + "require_last_push_approval": { + "description": "Whether the most recent push must be approved by someone other than the person who pushed it", + "type": "boolean" + }, + "required_approving_review_count": { + "type": "integer" + }, + "required_conversation_resolution_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "required_deployments_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "required_status_checks": { + "type": "array", + "items": { + "type": "string" + } + }, + "required_status_checks_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "signature_requirement_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "strict_required_status_checks_policy": { + "type": "boolean" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "id", + "repository_id", + "name", + "created_at", + "updated_at", + "pull_request_reviews_enforcement_level", + "required_approving_review_count", + "dismiss_stale_reviews_on_push", + "require_code_owner_review", + "authorized_dismissal_actors_only", + "ignore_approvals_from_contributors", + "required_status_checks", + "required_status_checks_enforcement_level", + "strict_required_status_checks_policy", + "signature_requirement_enforcement_level", + "linear_history_requirement_enforcement_level", + "admin_enforced", + "allow_force_pushes_enforcement_level", + "allow_deletions_enforcement_level", + "merge_queue_enforcement_level", + "required_deployments_enforcement_level", + "required_conversation_resolution_level", + "authorized_actors_only", + "authorized_actor_names" + ] + }, "simple-check-suite": { "description": "A suite of checks performed on the code of a given code change", "type": "object", @@ -131797,169 +131966,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "rule": { - "title": "branch protection rule", - "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.", - "type": "object", - "properties": { - "admin_enforced": { - "type": "boolean" - }, - "allow_deletions_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "allow_force_pushes_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "authorized_actor_names": { - "type": "array", - "items": { - "type": "string" - } - }, - "authorized_actors_only": { - "type": "boolean" - }, - "authorized_dismissal_actors_only": { - "type": "boolean" - }, - "create_protected": { - "type": "boolean" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "dismiss_stale_reviews_on_push": { - "type": "boolean" - }, - "id": { - "type": "integer" - }, - "ignore_approvals_from_contributors": { - "type": "boolean" - }, - "linear_history_requirement_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "merge_queue_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "name": { - "type": "string" - }, - "pull_request_reviews_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "repository_id": { - "type": "integer" - }, - "require_code_owner_review": { - "type": "boolean" - }, - "require_last_push_approval": { - "description": "Whether the most recent push must be approved by someone other than the person who pushed it", - "type": "boolean" - }, - "required_approving_review_count": { - "type": "integer" - }, - "required_conversation_resolution_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "required_deployments_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "required_status_checks": { - "type": "array", - "items": { - "type": "string" - } - }, - "required_status_checks_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "signature_requirement_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "strict_required_status_checks_policy": { - "type": "boolean" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "repository_id", - "name", - "created_at", - "updated_at", - "pull_request_reviews_enforcement_level", - "required_approving_review_count", - "dismiss_stale_reviews_on_push", - "require_code_owner_review", - "authorized_dismissal_actors_only", - "ignore_approvals_from_contributors", - "required_status_checks", - "required_status_checks_enforcement_level", - "strict_required_status_checks_policy", - "signature_requirement_enforcement_level", - "linear_history_requirement_enforcement_level", - "admin_enforced", - "allow_force_pushes_enforcement_level", - "allow_deletions_enforcement_level", - "merge_queue_enforcement_level", - "required_deployments_enforcement_level", - "required_conversation_resolution_level", - "authorized_actors_only", - "authorized_actor_names" - ] + "$ref": "#/components/schemas/webhooks_rule" }, "sender": { "$ref": "#/components/schemas/simple-user-webhooks" @@ -131995,169 +132002,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "rule": { - "title": "branch protection rule", - "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.", - "type": "object", - "properties": { - "admin_enforced": { - "type": "boolean" - }, - "allow_deletions_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "allow_force_pushes_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "authorized_actor_names": { - "type": "array", - "items": { - "type": "string" - } - }, - "authorized_actors_only": { - "type": "boolean" - }, - "authorized_dismissal_actors_only": { - "type": "boolean" - }, - "create_protected": { - "type": "boolean" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "dismiss_stale_reviews_on_push": { - "type": "boolean" - }, - "id": { - "type": "integer" - }, - "ignore_approvals_from_contributors": { - "type": "boolean" - }, - "linear_history_requirement_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "merge_queue_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "name": { - "type": "string" - }, - "pull_request_reviews_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "repository_id": { - "type": "integer" - }, - "require_code_owner_review": { - "type": "boolean" - }, - "require_last_push_approval": { - "description": "Whether the most recent push must be approved by someone other than the person who pushed it", - "type": "boolean" - }, - "required_approving_review_count": { - "type": "integer" - }, - "required_conversation_resolution_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "required_deployments_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "required_status_checks": { - "type": "array", - "items": { - "type": "string" - } - }, - "required_status_checks_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "signature_requirement_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "strict_required_status_checks_policy": { - "type": "boolean" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "repository_id", - "name", - "created_at", - "updated_at", - "pull_request_reviews_enforcement_level", - "required_approving_review_count", - "dismiss_stale_reviews_on_push", - "require_code_owner_review", - "authorized_dismissal_actors_only", - "ignore_approvals_from_contributors", - "required_status_checks", - "required_status_checks_enforcement_level", - "strict_required_status_checks_policy", - "signature_requirement_enforcement_level", - "linear_history_requirement_enforcement_level", - "admin_enforced", - "allow_force_pushes_enforcement_level", - "allow_deletions_enforcement_level", - "merge_queue_enforcement_level", - "required_deployments_enforcement_level", - "required_conversation_resolution_level", - "authorized_actors_only", - "authorized_actor_names" - ] + "$ref": "#/components/schemas/webhooks_rule" }, "sender": { "$ref": "#/components/schemas/simple-user-webhooks" @@ -132295,169 +132140,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "rule": { - "title": "branch protection rule", - "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.", - "type": "object", - "properties": { - "admin_enforced": { - "type": "boolean" - }, - "allow_deletions_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "allow_force_pushes_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "authorized_actor_names": { - "type": "array", - "items": { - "type": "string" - } - }, - "authorized_actors_only": { - "type": "boolean" - }, - "authorized_dismissal_actors_only": { - "type": "boolean" - }, - "create_protected": { - "type": "boolean" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "dismiss_stale_reviews_on_push": { - "type": "boolean" - }, - "id": { - "type": "integer" - }, - "ignore_approvals_from_contributors": { - "type": "boolean" - }, - "linear_history_requirement_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "merge_queue_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "name": { - "type": "string" - }, - "pull_request_reviews_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "repository_id": { - "type": "integer" - }, - "require_code_owner_review": { - "type": "boolean" - }, - "require_last_push_approval": { - "description": "Whether the most recent push must be approved by someone other than the person who pushed it", - "type": "boolean" - }, - "required_approving_review_count": { - "type": "integer" - }, - "required_conversation_resolution_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "required_deployments_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "required_status_checks": { - "type": "array", - "items": { - "type": "string" - } - }, - "required_status_checks_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "signature_requirement_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "strict_required_status_checks_policy": { - "type": "boolean" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "repository_id", - "name", - "created_at", - "updated_at", - "pull_request_reviews_enforcement_level", - "required_approving_review_count", - "dismiss_stale_reviews_on_push", - "require_code_owner_review", - "authorized_dismissal_actors_only", - "ignore_approvals_from_contributors", - "required_status_checks", - "required_status_checks_enforcement_level", - "strict_required_status_checks_policy", - "signature_requirement_enforcement_level", - "linear_history_requirement_enforcement_level", - "admin_enforced", - "allow_force_pushes_enforcement_level", - "allow_deletions_enforcement_level", - "merge_queue_enforcement_level", - "required_deployments_enforcement_level", - "required_conversation_resolution_level", - "authorized_actors_only", - "authorized_actor_names" - ] + "$ref": "#/components/schemas/webhooks_rule" }, "sender": { "$ref": "#/components/schemas/simple-user-webhooks" diff --git a/cache/ghes-3.10.json b/cache/ghes-3.10.json index b2cee5be4..fa948a878 100644 --- a/cache/ghes-3.10.json +++ b/cache/ghes-3.10.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "16.2.0", + "version": "16.3.0", "title": "GitHub's official OpenAPI spec + Octokit extension", "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs", "license": { @@ -117655,6 +117655,171 @@ "updated_at" ] }, + "webhooks_rule": { + "title": "branch protection rule", + "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-server@3.10/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.", + "type": "object", + "properties": { + "admin_enforced": { + "type": "boolean" + }, + "allow_deletions_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "allow_force_pushes_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "authorized_actor_names": { + "type": "array", + "items": { + "type": "string" + } + }, + "authorized_actors_only": { + "type": "boolean" + }, + "authorized_dismissal_actors_only": { + "type": "boolean" + }, + "create_protected": { + "type": "boolean" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "dismiss_stale_reviews_on_push": { + "type": "boolean" + }, + "id": { + "type": "integer" + }, + "ignore_approvals_from_contributors": { + "type": "boolean" + }, + "linear_history_requirement_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "merge_queue_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "name": { + "type": "string" + }, + "pull_request_reviews_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "repository_id": { + "type": "integer" + }, + "require_code_owner_review": { + "type": "boolean" + }, + "require_last_push_approval": { + "description": "Whether the most recent push must be approved by someone other than the person who pushed it", + "type": "boolean" + }, + "required_approving_review_count": { + "type": "integer" + }, + "required_conversation_resolution_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "required_deployments_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "required_status_checks": { + "type": "array", + "items": { + "type": "string" + } + }, + "required_status_checks_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "signature_requirement_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "strict_required_status_checks_policy": { + "type": "boolean" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "id", + "repository_id", + "name", + "created_at", + "updated_at", + "pull_request_reviews_enforcement_level", + "required_approving_review_count", + "dismiss_stale_reviews_on_push", + "require_code_owner_review", + "authorized_dismissal_actors_only", + "ignore_approvals_from_contributors", + "required_status_checks", + "required_status_checks_enforcement_level", + "strict_required_status_checks_policy", + "signature_requirement_enforcement_level", + "linear_history_requirement_enforcement_level", + "admin_enforced", + "allow_force_pushes_enforcement_level", + "allow_deletions_enforcement_level", + "merge_queue_enforcement_level", + "required_deployments_enforcement_level", + "required_conversation_resolution_level", + "authorized_actors_only", + "authorized_actor_names" + ] + }, "simple-user-webhooks": { "title": "Simple User", "description": "The GitHub user that triggered the event. This property is included in every webhook payload.", @@ -119805,169 +119970,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "rule": { - "title": "branch protection rule", - "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-server@3.10/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.", - "type": "object", - "properties": { - "admin_enforced": { - "type": "boolean" - }, - "allow_deletions_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "allow_force_pushes_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "authorized_actor_names": { - "type": "array", - "items": { - "type": "string" - } - }, - "authorized_actors_only": { - "type": "boolean" - }, - "authorized_dismissal_actors_only": { - "type": "boolean" - }, - "create_protected": { - "type": "boolean" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "dismiss_stale_reviews_on_push": { - "type": "boolean" - }, - "id": { - "type": "integer" - }, - "ignore_approvals_from_contributors": { - "type": "boolean" - }, - "linear_history_requirement_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "merge_queue_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "name": { - "type": "string" - }, - "pull_request_reviews_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "repository_id": { - "type": "integer" - }, - "require_code_owner_review": { - "type": "boolean" - }, - "require_last_push_approval": { - "description": "Whether the most recent push must be approved by someone other than the person who pushed it", - "type": "boolean" - }, - "required_approving_review_count": { - "type": "integer" - }, - "required_conversation_resolution_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "required_deployments_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "required_status_checks": { - "type": "array", - "items": { - "type": "string" - } - }, - "required_status_checks_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "signature_requirement_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "strict_required_status_checks_policy": { - "type": "boolean" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "repository_id", - "name", - "created_at", - "updated_at", - "pull_request_reviews_enforcement_level", - "required_approving_review_count", - "dismiss_stale_reviews_on_push", - "require_code_owner_review", - "authorized_dismissal_actors_only", - "ignore_approvals_from_contributors", - "required_status_checks", - "required_status_checks_enforcement_level", - "strict_required_status_checks_policy", - "signature_requirement_enforcement_level", - "linear_history_requirement_enforcement_level", - "admin_enforced", - "allow_force_pushes_enforcement_level", - "allow_deletions_enforcement_level", - "merge_queue_enforcement_level", - "required_deployments_enforcement_level", - "required_conversation_resolution_level", - "authorized_actors_only", - "authorized_actor_names" - ] + "$ref": "#/components/schemas/webhooks_rule" }, "sender": { "$ref": "#/components/schemas/simple-user-webhooks" @@ -120003,169 +120006,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "rule": { - "title": "branch protection rule", - "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-server@3.10/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.", - "type": "object", - "properties": { - "admin_enforced": { - "type": "boolean" - }, - "allow_deletions_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "allow_force_pushes_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "authorized_actor_names": { - "type": "array", - "items": { - "type": "string" - } - }, - "authorized_actors_only": { - "type": "boolean" - }, - "authorized_dismissal_actors_only": { - "type": "boolean" - }, - "create_protected": { - "type": "boolean" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "dismiss_stale_reviews_on_push": { - "type": "boolean" - }, - "id": { - "type": "integer" - }, - "ignore_approvals_from_contributors": { - "type": "boolean" - }, - "linear_history_requirement_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "merge_queue_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "name": { - "type": "string" - }, - "pull_request_reviews_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "repository_id": { - "type": "integer" - }, - "require_code_owner_review": { - "type": "boolean" - }, - "require_last_push_approval": { - "description": "Whether the most recent push must be approved by someone other than the person who pushed it", - "type": "boolean" - }, - "required_approving_review_count": { - "type": "integer" - }, - "required_conversation_resolution_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "required_deployments_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "required_status_checks": { - "type": "array", - "items": { - "type": "string" - } - }, - "required_status_checks_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "signature_requirement_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "strict_required_status_checks_policy": { - "type": "boolean" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "repository_id", - "name", - "created_at", - "updated_at", - "pull_request_reviews_enforcement_level", - "required_approving_review_count", - "dismiss_stale_reviews_on_push", - "require_code_owner_review", - "authorized_dismissal_actors_only", - "ignore_approvals_from_contributors", - "required_status_checks", - "required_status_checks_enforcement_level", - "strict_required_status_checks_policy", - "signature_requirement_enforcement_level", - "linear_history_requirement_enforcement_level", - "admin_enforced", - "allow_force_pushes_enforcement_level", - "allow_deletions_enforcement_level", - "merge_queue_enforcement_level", - "required_deployments_enforcement_level", - "required_conversation_resolution_level", - "authorized_actors_only", - "authorized_actor_names" - ] + "$ref": "#/components/schemas/webhooks_rule" }, "sender": { "$ref": "#/components/schemas/simple-user-webhooks" @@ -120303,169 +120144,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "rule": { - "title": "branch protection rule", - "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-server@3.10/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.", - "type": "object", - "properties": { - "admin_enforced": { - "type": "boolean" - }, - "allow_deletions_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "allow_force_pushes_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "authorized_actor_names": { - "type": "array", - "items": { - "type": "string" - } - }, - "authorized_actors_only": { - "type": "boolean" - }, - "authorized_dismissal_actors_only": { - "type": "boolean" - }, - "create_protected": { - "type": "boolean" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "dismiss_stale_reviews_on_push": { - "type": "boolean" - }, - "id": { - "type": "integer" - }, - "ignore_approvals_from_contributors": { - "type": "boolean" - }, - "linear_history_requirement_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "merge_queue_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "name": { - "type": "string" - }, - "pull_request_reviews_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "repository_id": { - "type": "integer" - }, - "require_code_owner_review": { - "type": "boolean" - }, - "require_last_push_approval": { - "description": "Whether the most recent push must be approved by someone other than the person who pushed it", - "type": "boolean" - }, - "required_approving_review_count": { - "type": "integer" - }, - "required_conversation_resolution_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "required_deployments_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "required_status_checks": { - "type": "array", - "items": { - "type": "string" - } - }, - "required_status_checks_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "signature_requirement_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "strict_required_status_checks_policy": { - "type": "boolean" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "repository_id", - "name", - "created_at", - "updated_at", - "pull_request_reviews_enforcement_level", - "required_approving_review_count", - "dismiss_stale_reviews_on_push", - "require_code_owner_review", - "authorized_dismissal_actors_only", - "ignore_approvals_from_contributors", - "required_status_checks", - "required_status_checks_enforcement_level", - "strict_required_status_checks_policy", - "signature_requirement_enforcement_level", - "linear_history_requirement_enforcement_level", - "admin_enforced", - "allow_force_pushes_enforcement_level", - "allow_deletions_enforcement_level", - "merge_queue_enforcement_level", - "required_deployments_enforcement_level", - "required_conversation_resolution_level", - "authorized_actors_only", - "authorized_actor_names" - ] + "$ref": "#/components/schemas/webhooks_rule" }, "sender": { "$ref": "#/components/schemas/simple-user-webhooks" diff --git a/cache/ghes-3.11.json b/cache/ghes-3.11.json index bfeb48abc..54a48dab5 100644 --- a/cache/ghes-3.11.json +++ b/cache/ghes-3.11.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "16.2.0", + "version": "16.3.0", "title": "GitHub's official OpenAPI spec + Octokit extension", "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs", "license": { @@ -91626,6 +91626,56 @@ "swift" ] }, + "vulnerability": { + "description": "A vulnerability describing the product and its affected versions within a GitHub Security Advisory.", + "type": "object", + "properties": { + "package": { + "description": "The name of the package affected by the vulnerability.", + "type": "object", + "nullable": true, + "properties": { + "ecosystem": { + "$ref": "#/components/schemas/security-advisory-ecosystems" + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "nullable": true + } + }, + "required": [ + "ecosystem", + "name" + ] + }, + "vulnerable_version_range": { + "type": "string", + "description": "The range of the package versions affected by the vulnerability.", + "nullable": true + }, + "first_patched_version": { + "type": "string", + "description": "The package version that resolves the vulnerability.", + "nullable": true + }, + "vulnerable_functions": { + "type": "array", + "description": "The functions in the package that are affected by the vulnerability.", + "nullable": true, + "readOnly": true, + "items": { + "type": "string" + } + } + }, + "required": [ + "package", + "vulnerable_version_range", + "first_patched_version", + "vulnerable_functions" + ] + }, "security-advisory-credit-types": { "type": "string", "description": "The type of credit the user is receiving.", @@ -91785,53 +91835,7 @@ "description": "The products and respective version ranges affected by the advisory.", "nullable": true, "items": { - "type": "object", - "properties": { - "package": { - "description": "The name of the package affected by the vulnerability.", - "type": "object", - "nullable": true, - "properties": { - "ecosystem": { - "$ref": "#/components/schemas/security-advisory-ecosystems" - }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "nullable": true - } - }, - "required": [ - "ecosystem", - "name" - ] - }, - "vulnerable_version_range": { - "type": "string", - "description": "The range of the package versions affected by the vulnerability.", - "nullable": true - }, - "first_patched_version": { - "type": "string", - "description": "The package version that resolve the vulnerability.", - "nullable": true - }, - "vulnerable_functions": { - "type": "array", - "description": "The functions in the package that are affected by the vulnerability.", - "nullable": true, - "readOnly": true, - "items": { - "type": "string" - } - } - }, - "required": [ - "package", - "vulnerable_version_range", - "first_patched_version", - "vulnerable_functions" - ] + "$ref": "#/components/schemas/vulnerability" } }, "cvss": { @@ -121143,6 +121147,171 @@ "url" ] }, + "webhooks_rule": { + "title": "branch protection rule", + "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-server@3.11/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.", + "type": "object", + "properties": { + "admin_enforced": { + "type": "boolean" + }, + "allow_deletions_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "allow_force_pushes_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "authorized_actor_names": { + "type": "array", + "items": { + "type": "string" + } + }, + "authorized_actors_only": { + "type": "boolean" + }, + "authorized_dismissal_actors_only": { + "type": "boolean" + }, + "create_protected": { + "type": "boolean" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "dismiss_stale_reviews_on_push": { + "type": "boolean" + }, + "id": { + "type": "integer" + }, + "ignore_approvals_from_contributors": { + "type": "boolean" + }, + "linear_history_requirement_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "merge_queue_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "name": { + "type": "string" + }, + "pull_request_reviews_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "repository_id": { + "type": "integer" + }, + "require_code_owner_review": { + "type": "boolean" + }, + "require_last_push_approval": { + "description": "Whether the most recent push must be approved by someone other than the person who pushed it", + "type": "boolean" + }, + "required_approving_review_count": { + "type": "integer" + }, + "required_conversation_resolution_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "required_deployments_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "required_status_checks": { + "type": "array", + "items": { + "type": "string" + } + }, + "required_status_checks_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "signature_requirement_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "strict_required_status_checks_policy": { + "type": "boolean" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "id", + "repository_id", + "name", + "created_at", + "updated_at", + "pull_request_reviews_enforcement_level", + "required_approving_review_count", + "dismiss_stale_reviews_on_push", + "require_code_owner_review", + "authorized_dismissal_actors_only", + "ignore_approvals_from_contributors", + "required_status_checks", + "required_status_checks_enforcement_level", + "strict_required_status_checks_policy", + "signature_requirement_enforcement_level", + "linear_history_requirement_enforcement_level", + "admin_enforced", + "allow_force_pushes_enforcement_level", + "allow_deletions_enforcement_level", + "merge_queue_enforcement_level", + "required_deployments_enforcement_level", + "required_conversation_resolution_level", + "authorized_actors_only", + "authorized_actor_names" + ] + }, "simple-check-suite": { "description": "A suite of checks performed on the code of a given code change", "type": "object", @@ -123238,169 +123407,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "rule": { - "title": "branch protection rule", - "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-server@3.11/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.", - "type": "object", - "properties": { - "admin_enforced": { - "type": "boolean" - }, - "allow_deletions_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "allow_force_pushes_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "authorized_actor_names": { - "type": "array", - "items": { - "type": "string" - } - }, - "authorized_actors_only": { - "type": "boolean" - }, - "authorized_dismissal_actors_only": { - "type": "boolean" - }, - "create_protected": { - "type": "boolean" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "dismiss_stale_reviews_on_push": { - "type": "boolean" - }, - "id": { - "type": "integer" - }, - "ignore_approvals_from_contributors": { - "type": "boolean" - }, - "linear_history_requirement_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "merge_queue_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "name": { - "type": "string" - }, - "pull_request_reviews_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "repository_id": { - "type": "integer" - }, - "require_code_owner_review": { - "type": "boolean" - }, - "require_last_push_approval": { - "description": "Whether the most recent push must be approved by someone other than the person who pushed it", - "type": "boolean" - }, - "required_approving_review_count": { - "type": "integer" - }, - "required_conversation_resolution_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "required_deployments_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "required_status_checks": { - "type": "array", - "items": { - "type": "string" - } - }, - "required_status_checks_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "signature_requirement_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "strict_required_status_checks_policy": { - "type": "boolean" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "repository_id", - "name", - "created_at", - "updated_at", - "pull_request_reviews_enforcement_level", - "required_approving_review_count", - "dismiss_stale_reviews_on_push", - "require_code_owner_review", - "authorized_dismissal_actors_only", - "ignore_approvals_from_contributors", - "required_status_checks", - "required_status_checks_enforcement_level", - "strict_required_status_checks_policy", - "signature_requirement_enforcement_level", - "linear_history_requirement_enforcement_level", - "admin_enforced", - "allow_force_pushes_enforcement_level", - "allow_deletions_enforcement_level", - "merge_queue_enforcement_level", - "required_deployments_enforcement_level", - "required_conversation_resolution_level", - "authorized_actors_only", - "authorized_actor_names" - ] + "$ref": "#/components/schemas/webhooks_rule" }, "sender": { "$ref": "#/components/schemas/simple-user-webhooks" @@ -123436,169 +123443,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "rule": { - "title": "branch protection rule", - "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-server@3.11/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.", - "type": "object", - "properties": { - "admin_enforced": { - "type": "boolean" - }, - "allow_deletions_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "allow_force_pushes_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "authorized_actor_names": { - "type": "array", - "items": { - "type": "string" - } - }, - "authorized_actors_only": { - "type": "boolean" - }, - "authorized_dismissal_actors_only": { - "type": "boolean" - }, - "create_protected": { - "type": "boolean" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "dismiss_stale_reviews_on_push": { - "type": "boolean" - }, - "id": { - "type": "integer" - }, - "ignore_approvals_from_contributors": { - "type": "boolean" - }, - "linear_history_requirement_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "merge_queue_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "name": { - "type": "string" - }, - "pull_request_reviews_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "repository_id": { - "type": "integer" - }, - "require_code_owner_review": { - "type": "boolean" - }, - "require_last_push_approval": { - "description": "Whether the most recent push must be approved by someone other than the person who pushed it", - "type": "boolean" - }, - "required_approving_review_count": { - "type": "integer" - }, - "required_conversation_resolution_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "required_deployments_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "required_status_checks": { - "type": "array", - "items": { - "type": "string" - } - }, - "required_status_checks_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "signature_requirement_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "strict_required_status_checks_policy": { - "type": "boolean" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "repository_id", - "name", - "created_at", - "updated_at", - "pull_request_reviews_enforcement_level", - "required_approving_review_count", - "dismiss_stale_reviews_on_push", - "require_code_owner_review", - "authorized_dismissal_actors_only", - "ignore_approvals_from_contributors", - "required_status_checks", - "required_status_checks_enforcement_level", - "strict_required_status_checks_policy", - "signature_requirement_enforcement_level", - "linear_history_requirement_enforcement_level", - "admin_enforced", - "allow_force_pushes_enforcement_level", - "allow_deletions_enforcement_level", - "merge_queue_enforcement_level", - "required_deployments_enforcement_level", - "required_conversation_resolution_level", - "authorized_actors_only", - "authorized_actor_names" - ] + "$ref": "#/components/schemas/webhooks_rule" }, "sender": { "$ref": "#/components/schemas/simple-user-webhooks" @@ -123736,169 +123581,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "rule": { - "title": "branch protection rule", - "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-server@3.11/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.", - "type": "object", - "properties": { - "admin_enforced": { - "type": "boolean" - }, - "allow_deletions_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "allow_force_pushes_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "authorized_actor_names": { - "type": "array", - "items": { - "type": "string" - } - }, - "authorized_actors_only": { - "type": "boolean" - }, - "authorized_dismissal_actors_only": { - "type": "boolean" - }, - "create_protected": { - "type": "boolean" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "dismiss_stale_reviews_on_push": { - "type": "boolean" - }, - "id": { - "type": "integer" - }, - "ignore_approvals_from_contributors": { - "type": "boolean" - }, - "linear_history_requirement_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "merge_queue_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "name": { - "type": "string" - }, - "pull_request_reviews_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "repository_id": { - "type": "integer" - }, - "require_code_owner_review": { - "type": "boolean" - }, - "require_last_push_approval": { - "description": "Whether the most recent push must be approved by someone other than the person who pushed it", - "type": "boolean" - }, - "required_approving_review_count": { - "type": "integer" - }, - "required_conversation_resolution_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "required_deployments_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "required_status_checks": { - "type": "array", - "items": { - "type": "string" - } - }, - "required_status_checks_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "signature_requirement_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "strict_required_status_checks_policy": { - "type": "boolean" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "repository_id", - "name", - "created_at", - "updated_at", - "pull_request_reviews_enforcement_level", - "required_approving_review_count", - "dismiss_stale_reviews_on_push", - "require_code_owner_review", - "authorized_dismissal_actors_only", - "ignore_approvals_from_contributors", - "required_status_checks", - "required_status_checks_enforcement_level", - "strict_required_status_checks_policy", - "signature_requirement_enforcement_level", - "linear_history_requirement_enforcement_level", - "admin_enforced", - "allow_force_pushes_enforcement_level", - "allow_deletions_enforcement_level", - "merge_queue_enforcement_level", - "required_deployments_enforcement_level", - "required_conversation_resolution_level", - "authorized_actors_only", - "authorized_actor_names" - ] + "$ref": "#/components/schemas/webhooks_rule" }, "sender": { "$ref": "#/components/schemas/simple-user-webhooks" diff --git a/cache/ghes-3.12.json b/cache/ghes-3.12.json index f7dd44b9f..ef073e876 100644 --- a/cache/ghes-3.12.json +++ b/cache/ghes-3.12.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "16.2.0", + "version": "16.3.0", "title": "GitHub's official OpenAPI spec + Octokit extension", "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs", "license": { @@ -10794,6 +10794,360 @@ "x-octokit": {} } }, + "/manage/v1/config/apply": { + "get": { + "summary": "Get the status of a ghe-config-apply run", + "description": "Displays the current status of `ghe-config-apply` in the environment or the status of a historical run by ID.", + "operationId": "enterprise-admin/get-manage-settings", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#get-config-apply-status" + }, + "parameters": [ + { + "name": "run_id", + "description": "The unique run ID of the `ghe-config-apply` run.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "running": { + "type": "boolean", + "description": "Whether the ghe-config-apply run is still running in the environment" + }, + "successful": { + "type": "boolean", + "description": "Whether the ghe-config-apply run was successful in the environment" + }, + "nodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "run_id": { + "type": "string", + "description": "The unique Run ID of the ghe-config-apply run on the host" + }, + "hostname": { + "type": "string", + "description": "The hostname of the node" + }, + "running": { + "type": "boolean", + "description": "Whether the ghe-config-apply run is still running on the host" + }, + "successful": { + "type": "boolean", + "description": "Whether the ghe-config-apply run was successful on the host" + } + } + } + } + } + }, + "examples": { + "default": { + "value": { + "running": true, + "successful": false, + "nodes": [ + { + "run_id": "d34db33f", + "hostname": "ghes-01.lan", + "running": true, + "successful": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad request" + }, + "401": { + "description": "Unauthorized" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "manage-ghes" + }, + "x-octokit": {} + }, + "post": { + "summary": "Trigger a ghe-config-apply run", + "description": "Triggers a run of `ghe-config-apply` from the `ghes-manage` agent on your Nomad Delegate instance.\nYou can provide a run ID or allow one to be generated randomly.", + "operationId": "enterprise-admin/get-manage-settings", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#run-config-apply" + }, + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "run_id": { + "type": "string", + "description": "The run ID to execute `ghe-config-apply` with. If not provided, a run ID will be generated randomly." + } + } + }, + "examples": { + "default": { + "value": { + "run_id": "d34db33f" + } + } + } + } + } + }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "run_id": { + "type": "string", + "description": "Run ID the job was launched with" + } + } + }, + "examples": { + "default": { + "value": { + "run_id": "d34db33f" + } + } + } + } + } + }, + "400": { + "description": "Bad request" + }, + "401": { + "description": "Unauthorized" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "manage-ghes" + }, + "x-octokit": {} + } + }, + "/manage/v1/config/apply/events": { + "get": { + "summary": "List events from ghe-config-apply", + "description": "Lists events from an in-process `ghe-config-apply` run on your Github Enterprise Server instance.", + "operationId": "enterprise-admin/get-manage-settings", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#get-config-apply-events" + }, + "parameters": [ + { + "name": "last_request_id", + "description": "The unique ID of the last response from a host, used for pagination.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "node": { + "type": "string", + "description": "Hostname of the node" + }, + "last_request_id": { + "type": "string", + "description": "Unique ID of the last response from a host used for pagination" + }, + "events": { + "type": "array", + "items": { + "type": "object", + "properties": { + "timestamp": { + "type": "string" + }, + "severity_text": { + "type": "string" + }, + "body": { + "type": "string" + }, + "event_name": { + "type": "string" + }, + "topology": { + "type": "string" + }, + "hostname": { + "type": "string" + }, + "config_run_id": { + "type": "string" + }, + "trace_id": { + "type": "string" + }, + "span_id": { + "type": "string" + }, + "span_parent_id": { + "type": "string" + }, + "span_depth": { + "type": "integer" + } + } + } + } + } + } + } + } + }, + "examples": { + "default": { + "value": { + "nodes": [ + { + "node": "ghes-01.lan", + "last_request_id": "387cd628c06d606700e79be368e5e574:0cde553750689c76:0000000000000000", + "events": [ + { + "timestamp": "2023-01-01T13:00:00+00:00", + "severity_text": "INFO", + "body": "Validating services", + "event_name": "Enterprise::ConfigApply::PhaseValidation#config_phase_validation", + "topology": "multinode", + "hostname": "ghes-01.lan", + "config_run_id": "d34db33f", + "trace_id": "387cd628c06d606700e79be368e5e574", + "span_id": "0cde553750689c76", + "span_parent_id": 0, + "span_depth": 0 + } + ] + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad request" + }, + "401": { + "description": "Unauthorized" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "manage-ghes" + }, + "x-octokit": {} + } + }, "/manage/v1/config/init": { "post": { "summary": "Initialize instance configuration with license upload", @@ -92844,6 +93198,56 @@ "swift" ] }, + "vulnerability": { + "description": "A vulnerability describing the product and its affected versions within a GitHub Security Advisory.", + "type": "object", + "properties": { + "package": { + "description": "The name of the package affected by the vulnerability.", + "type": "object", + "nullable": true, + "properties": { + "ecosystem": { + "$ref": "#/components/schemas/security-advisory-ecosystems" + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "nullable": true + } + }, + "required": [ + "ecosystem", + "name" + ] + }, + "vulnerable_version_range": { + "type": "string", + "description": "The range of the package versions affected by the vulnerability.", + "nullable": true + }, + "first_patched_version": { + "type": "string", + "description": "The package version that resolves the vulnerability.", + "nullable": true + }, + "vulnerable_functions": { + "type": "array", + "description": "The functions in the package that are affected by the vulnerability.", + "nullable": true, + "readOnly": true, + "items": { + "type": "string" + } + } + }, + "required": [ + "package", + "vulnerable_version_range", + "first_patched_version", + "vulnerable_functions" + ] + }, "security-advisory-credit-types": { "type": "string", "description": "The type of credit the user is receiving.", @@ -93003,53 +93407,7 @@ "description": "The products and respective version ranges affected by the advisory.", "nullable": true, "items": { - "type": "object", - "properties": { - "package": { - "description": "The name of the package affected by the vulnerability.", - "type": "object", - "nullable": true, - "properties": { - "ecosystem": { - "$ref": "#/components/schemas/security-advisory-ecosystems" - }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "nullable": true - } - }, - "required": [ - "ecosystem", - "name" - ] - }, - "vulnerable_version_range": { - "type": "string", - "description": "The range of the package versions affected by the vulnerability.", - "nullable": true - }, - "first_patched_version": { - "type": "string", - "description": "The package version that resolve the vulnerability.", - "nullable": true - }, - "vulnerable_functions": { - "type": "array", - "description": "The functions in the package that are affected by the vulnerability.", - "nullable": true, - "readOnly": true, - "items": { - "type": "string" - } - } - }, - "required": [ - "package", - "vulnerable_version_range", - "first_patched_version", - "vulnerable_functions" - ] + "$ref": "#/components/schemas/vulnerability" } }, "cvss": { @@ -123283,6 +123641,171 @@ "url" ] }, + "webhooks_rule": { + "title": "branch protection rule", + "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-server@3.12/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.", + "type": "object", + "properties": { + "admin_enforced": { + "type": "boolean" + }, + "allow_deletions_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "allow_force_pushes_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "authorized_actor_names": { + "type": "array", + "items": { + "type": "string" + } + }, + "authorized_actors_only": { + "type": "boolean" + }, + "authorized_dismissal_actors_only": { + "type": "boolean" + }, + "create_protected": { + "type": "boolean" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "dismiss_stale_reviews_on_push": { + "type": "boolean" + }, + "id": { + "type": "integer" + }, + "ignore_approvals_from_contributors": { + "type": "boolean" + }, + "linear_history_requirement_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "merge_queue_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "name": { + "type": "string" + }, + "pull_request_reviews_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "repository_id": { + "type": "integer" + }, + "require_code_owner_review": { + "type": "boolean" + }, + "require_last_push_approval": { + "description": "Whether the most recent push must be approved by someone other than the person who pushed it", + "type": "boolean" + }, + "required_approving_review_count": { + "type": "integer" + }, + "required_conversation_resolution_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "required_deployments_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "required_status_checks": { + "type": "array", + "items": { + "type": "string" + } + }, + "required_status_checks_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "signature_requirement_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "strict_required_status_checks_policy": { + "type": "boolean" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "id", + "repository_id", + "name", + "created_at", + "updated_at", + "pull_request_reviews_enforcement_level", + "required_approving_review_count", + "dismiss_stale_reviews_on_push", + "require_code_owner_review", + "authorized_dismissal_actors_only", + "ignore_approvals_from_contributors", + "required_status_checks", + "required_status_checks_enforcement_level", + "strict_required_status_checks_policy", + "signature_requirement_enforcement_level", + "linear_history_requirement_enforcement_level", + "admin_enforced", + "allow_force_pushes_enforcement_level", + "allow_deletions_enforcement_level", + "merge_queue_enforcement_level", + "required_deployments_enforcement_level", + "required_conversation_resolution_level", + "authorized_actors_only", + "authorized_actor_names" + ] + }, "simple-check-suite": { "description": "A suite of checks performed on the code of a given code change", "type": "object", @@ -125378,169 +125901,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "rule": { - "title": "branch protection rule", - "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-server@3.12/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.", - "type": "object", - "properties": { - "admin_enforced": { - "type": "boolean" - }, - "allow_deletions_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "allow_force_pushes_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "authorized_actor_names": { - "type": "array", - "items": { - "type": "string" - } - }, - "authorized_actors_only": { - "type": "boolean" - }, - "authorized_dismissal_actors_only": { - "type": "boolean" - }, - "create_protected": { - "type": "boolean" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "dismiss_stale_reviews_on_push": { - "type": "boolean" - }, - "id": { - "type": "integer" - }, - "ignore_approvals_from_contributors": { - "type": "boolean" - }, - "linear_history_requirement_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "merge_queue_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "name": { - "type": "string" - }, - "pull_request_reviews_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "repository_id": { - "type": "integer" - }, - "require_code_owner_review": { - "type": "boolean" - }, - "require_last_push_approval": { - "description": "Whether the most recent push must be approved by someone other than the person who pushed it", - "type": "boolean" - }, - "required_approving_review_count": { - "type": "integer" - }, - "required_conversation_resolution_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "required_deployments_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "required_status_checks": { - "type": "array", - "items": { - "type": "string" - } - }, - "required_status_checks_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "signature_requirement_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "strict_required_status_checks_policy": { - "type": "boolean" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "repository_id", - "name", - "created_at", - "updated_at", - "pull_request_reviews_enforcement_level", - "required_approving_review_count", - "dismiss_stale_reviews_on_push", - "require_code_owner_review", - "authorized_dismissal_actors_only", - "ignore_approvals_from_contributors", - "required_status_checks", - "required_status_checks_enforcement_level", - "strict_required_status_checks_policy", - "signature_requirement_enforcement_level", - "linear_history_requirement_enforcement_level", - "admin_enforced", - "allow_force_pushes_enforcement_level", - "allow_deletions_enforcement_level", - "merge_queue_enforcement_level", - "required_deployments_enforcement_level", - "required_conversation_resolution_level", - "authorized_actors_only", - "authorized_actor_names" - ] + "$ref": "#/components/schemas/webhooks_rule" }, "sender": { "$ref": "#/components/schemas/simple-user-webhooks" @@ -125576,169 +125937,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "rule": { - "title": "branch protection rule", - "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-server@3.12/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.", - "type": "object", - "properties": { - "admin_enforced": { - "type": "boolean" - }, - "allow_deletions_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "allow_force_pushes_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "authorized_actor_names": { - "type": "array", - "items": { - "type": "string" - } - }, - "authorized_actors_only": { - "type": "boolean" - }, - "authorized_dismissal_actors_only": { - "type": "boolean" - }, - "create_protected": { - "type": "boolean" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "dismiss_stale_reviews_on_push": { - "type": "boolean" - }, - "id": { - "type": "integer" - }, - "ignore_approvals_from_contributors": { - "type": "boolean" - }, - "linear_history_requirement_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "merge_queue_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "name": { - "type": "string" - }, - "pull_request_reviews_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "repository_id": { - "type": "integer" - }, - "require_code_owner_review": { - "type": "boolean" - }, - "require_last_push_approval": { - "description": "Whether the most recent push must be approved by someone other than the person who pushed it", - "type": "boolean" - }, - "required_approving_review_count": { - "type": "integer" - }, - "required_conversation_resolution_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "required_deployments_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "required_status_checks": { - "type": "array", - "items": { - "type": "string" - } - }, - "required_status_checks_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "signature_requirement_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "strict_required_status_checks_policy": { - "type": "boolean" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "repository_id", - "name", - "created_at", - "updated_at", - "pull_request_reviews_enforcement_level", - "required_approving_review_count", - "dismiss_stale_reviews_on_push", - "require_code_owner_review", - "authorized_dismissal_actors_only", - "ignore_approvals_from_contributors", - "required_status_checks", - "required_status_checks_enforcement_level", - "strict_required_status_checks_policy", - "signature_requirement_enforcement_level", - "linear_history_requirement_enforcement_level", - "admin_enforced", - "allow_force_pushes_enforcement_level", - "allow_deletions_enforcement_level", - "merge_queue_enforcement_level", - "required_deployments_enforcement_level", - "required_conversation_resolution_level", - "authorized_actors_only", - "authorized_actor_names" - ] + "$ref": "#/components/schemas/webhooks_rule" }, "sender": { "$ref": "#/components/schemas/simple-user-webhooks" @@ -125876,169 +126075,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "rule": { - "title": "branch protection rule", - "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-server@3.12/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.", - "type": "object", - "properties": { - "admin_enforced": { - "type": "boolean" - }, - "allow_deletions_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "allow_force_pushes_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "authorized_actor_names": { - "type": "array", - "items": { - "type": "string" - } - }, - "authorized_actors_only": { - "type": "boolean" - }, - "authorized_dismissal_actors_only": { - "type": "boolean" - }, - "create_protected": { - "type": "boolean" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "dismiss_stale_reviews_on_push": { - "type": "boolean" - }, - "id": { - "type": "integer" - }, - "ignore_approvals_from_contributors": { - "type": "boolean" - }, - "linear_history_requirement_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "merge_queue_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "name": { - "type": "string" - }, - "pull_request_reviews_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "repository_id": { - "type": "integer" - }, - "require_code_owner_review": { - "type": "boolean" - }, - "require_last_push_approval": { - "description": "Whether the most recent push must be approved by someone other than the person who pushed it", - "type": "boolean" - }, - "required_approving_review_count": { - "type": "integer" - }, - "required_conversation_resolution_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "required_deployments_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "required_status_checks": { - "type": "array", - "items": { - "type": "string" - } - }, - "required_status_checks_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "signature_requirement_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "strict_required_status_checks_policy": { - "type": "boolean" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "repository_id", - "name", - "created_at", - "updated_at", - "pull_request_reviews_enforcement_level", - "required_approving_review_count", - "dismiss_stale_reviews_on_push", - "require_code_owner_review", - "authorized_dismissal_actors_only", - "ignore_approvals_from_contributors", - "required_status_checks", - "required_status_checks_enforcement_level", - "strict_required_status_checks_policy", - "signature_requirement_enforcement_level", - "linear_history_requirement_enforcement_level", - "admin_enforced", - "allow_force_pushes_enforcement_level", - "allow_deletions_enforcement_level", - "merge_queue_enforcement_level", - "required_deployments_enforcement_level", - "required_conversation_resolution_level", - "authorized_actors_only", - "authorized_actor_names" - ] + "$ref": "#/components/schemas/webhooks_rule" }, "sender": { "$ref": "#/components/schemas/simple-user-webhooks" diff --git a/cache/ghes-3.9.json b/cache/ghes-3.9.json index d2ec73756..e9727086f 100644 --- a/cache/ghes-3.9.json +++ b/cache/ghes-3.9.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "16.2.0", + "version": "16.3.0", "title": "GitHub's official OpenAPI spec + Octokit extension", "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs", "license": { @@ -115059,6 +115059,167 @@ "updated_at" ] }, + "webhooks_rule": { + "title": "branch protection rule", + "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-server@3.9/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.", + "type": "object", + "properties": { + "admin_enforced": { + "type": "boolean" + }, + "allow_deletions_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "allow_force_pushes_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "authorized_actor_names": { + "type": "array", + "items": { + "type": "string" + } + }, + "authorized_actors_only": { + "type": "boolean" + }, + "authorized_dismissal_actors_only": { + "type": "boolean" + }, + "create_protected": { + "type": "boolean" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "dismiss_stale_reviews_on_push": { + "type": "boolean" + }, + "id": { + "type": "integer" + }, + "ignore_approvals_from_contributors": { + "type": "boolean" + }, + "linear_history_requirement_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "merge_queue_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "name": { + "type": "string" + }, + "pull_request_reviews_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "repository_id": { + "type": "integer" + }, + "require_code_owner_review": { + "type": "boolean" + }, + "required_approving_review_count": { + "type": "integer" + }, + "required_conversation_resolution_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "required_deployments_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "required_status_checks": { + "type": "array", + "items": { + "type": "string" + } + }, + "required_status_checks_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "signature_requirement_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "strict_required_status_checks_policy": { + "type": "boolean" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "id", + "repository_id", + "name", + "created_at", + "updated_at", + "pull_request_reviews_enforcement_level", + "required_approving_review_count", + "dismiss_stale_reviews_on_push", + "require_code_owner_review", + "authorized_dismissal_actors_only", + "ignore_approvals_from_contributors", + "required_status_checks", + "required_status_checks_enforcement_level", + "strict_required_status_checks_policy", + "signature_requirement_enforcement_level", + "linear_history_requirement_enforcement_level", + "admin_enforced", + "allow_force_pushes_enforcement_level", + "allow_deletions_enforcement_level", + "merge_queue_enforcement_level", + "required_deployments_enforcement_level", + "required_conversation_resolution_level", + "authorized_actors_only", + "authorized_actor_names" + ] + }, "simple-user-webhooks": { "title": "Simple User", "description": "The GitHub user that triggered the event. This property is included in every webhook payload.", @@ -117042,165 +117203,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "rule": { - "title": "branch protection rule", - "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-server@3.9/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.", - "type": "object", - "properties": { - "admin_enforced": { - "type": "boolean" - }, - "allow_deletions_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "allow_force_pushes_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "authorized_actor_names": { - "type": "array", - "items": { - "type": "string" - } - }, - "authorized_actors_only": { - "type": "boolean" - }, - "authorized_dismissal_actors_only": { - "type": "boolean" - }, - "create_protected": { - "type": "boolean" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "dismiss_stale_reviews_on_push": { - "type": "boolean" - }, - "id": { - "type": "integer" - }, - "ignore_approvals_from_contributors": { - "type": "boolean" - }, - "linear_history_requirement_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "merge_queue_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "name": { - "type": "string" - }, - "pull_request_reviews_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "repository_id": { - "type": "integer" - }, - "require_code_owner_review": { - "type": "boolean" - }, - "required_approving_review_count": { - "type": "integer" - }, - "required_conversation_resolution_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "required_deployments_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "required_status_checks": { - "type": "array", - "items": { - "type": "string" - } - }, - "required_status_checks_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "signature_requirement_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "strict_required_status_checks_policy": { - "type": "boolean" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "repository_id", - "name", - "created_at", - "updated_at", - "pull_request_reviews_enforcement_level", - "required_approving_review_count", - "dismiss_stale_reviews_on_push", - "require_code_owner_review", - "authorized_dismissal_actors_only", - "ignore_approvals_from_contributors", - "required_status_checks", - "required_status_checks_enforcement_level", - "strict_required_status_checks_policy", - "signature_requirement_enforcement_level", - "linear_history_requirement_enforcement_level", - "admin_enforced", - "allow_force_pushes_enforcement_level", - "allow_deletions_enforcement_level", - "merge_queue_enforcement_level", - "required_deployments_enforcement_level", - "required_conversation_resolution_level", - "authorized_actors_only", - "authorized_actor_names" - ] + "$ref": "#/components/schemas/webhooks_rule" }, "sender": { "$ref": "#/components/schemas/simple-user-webhooks" @@ -117236,165 +117239,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "rule": { - "title": "branch protection rule", - "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-server@3.9/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.", - "type": "object", - "properties": { - "admin_enforced": { - "type": "boolean" - }, - "allow_deletions_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "allow_force_pushes_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "authorized_actor_names": { - "type": "array", - "items": { - "type": "string" - } - }, - "authorized_actors_only": { - "type": "boolean" - }, - "authorized_dismissal_actors_only": { - "type": "boolean" - }, - "create_protected": { - "type": "boolean" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "dismiss_stale_reviews_on_push": { - "type": "boolean" - }, - "id": { - "type": "integer" - }, - "ignore_approvals_from_contributors": { - "type": "boolean" - }, - "linear_history_requirement_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "merge_queue_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "name": { - "type": "string" - }, - "pull_request_reviews_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "repository_id": { - "type": "integer" - }, - "require_code_owner_review": { - "type": "boolean" - }, - "required_approving_review_count": { - "type": "integer" - }, - "required_conversation_resolution_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "required_deployments_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "required_status_checks": { - "type": "array", - "items": { - "type": "string" - } - }, - "required_status_checks_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "signature_requirement_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "strict_required_status_checks_policy": { - "type": "boolean" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "repository_id", - "name", - "created_at", - "updated_at", - "pull_request_reviews_enforcement_level", - "required_approving_review_count", - "dismiss_stale_reviews_on_push", - "require_code_owner_review", - "authorized_dismissal_actors_only", - "ignore_approvals_from_contributors", - "required_status_checks", - "required_status_checks_enforcement_level", - "strict_required_status_checks_policy", - "signature_requirement_enforcement_level", - "linear_history_requirement_enforcement_level", - "admin_enforced", - "allow_force_pushes_enforcement_level", - "allow_deletions_enforcement_level", - "merge_queue_enforcement_level", - "required_deployments_enforcement_level", - "required_conversation_resolution_level", - "authorized_actors_only", - "authorized_actor_names" - ] + "$ref": "#/components/schemas/webhooks_rule" }, "sender": { "$ref": "#/components/schemas/simple-user-webhooks" @@ -117532,165 +117377,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "rule": { - "title": "branch protection rule", - "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-server@3.9/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.", - "type": "object", - "properties": { - "admin_enforced": { - "type": "boolean" - }, - "allow_deletions_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "allow_force_pushes_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "authorized_actor_names": { - "type": "array", - "items": { - "type": "string" - } - }, - "authorized_actors_only": { - "type": "boolean" - }, - "authorized_dismissal_actors_only": { - "type": "boolean" - }, - "create_protected": { - "type": "boolean" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "dismiss_stale_reviews_on_push": { - "type": "boolean" - }, - "id": { - "type": "integer" - }, - "ignore_approvals_from_contributors": { - "type": "boolean" - }, - "linear_history_requirement_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "merge_queue_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "name": { - "type": "string" - }, - "pull_request_reviews_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "repository_id": { - "type": "integer" - }, - "require_code_owner_review": { - "type": "boolean" - }, - "required_approving_review_count": { - "type": "integer" - }, - "required_conversation_resolution_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "required_deployments_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "required_status_checks": { - "type": "array", - "items": { - "type": "string" - } - }, - "required_status_checks_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "signature_requirement_enforcement_level": { - "type": "string", - "enum": [ - "off", - "non_admins", - "everyone" - ] - }, - "strict_required_status_checks_policy": { - "type": "boolean" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "repository_id", - "name", - "created_at", - "updated_at", - "pull_request_reviews_enforcement_level", - "required_approving_review_count", - "dismiss_stale_reviews_on_push", - "require_code_owner_review", - "authorized_dismissal_actors_only", - "ignore_approvals_from_contributors", - "required_status_checks", - "required_status_checks_enforcement_level", - "strict_required_status_checks_policy", - "signature_requirement_enforcement_level", - "linear_history_requirement_enforcement_level", - "admin_enforced", - "allow_force_pushes_enforcement_level", - "allow_deletions_enforcement_level", - "merge_queue_enforcement_level", - "required_deployments_enforcement_level", - "required_conversation_resolution_level", - "authorized_actors_only", - "authorized_actor_names" - ] + "$ref": "#/components/schemas/webhooks_rule" }, "sender": { "$ref": "#/components/schemas/simple-user-webhooks" diff --git a/cache/github.ae.json b/cache/github.ae.json index d7e423a57..f3c1e1fa6 100644 --- a/cache/github.ae.json +++ b/cache/github.ae.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "16.2.0", + "version": "16.3.0", "title": "GitHub's official OpenAPI spec + Octokit extension", "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs", "license": { diff --git a/packages/openapi-types-ghec/package.json b/packages/openapi-types-ghec/package.json index 111e2d82e..a67f6f3b5 100644 --- a/packages/openapi-types-ghec/package.json +++ b/packages/openapi-types-ghec/package.json @@ -16,6 +16,6 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "octokit": { - "openapi-version": "16.2.0" + "openapi-version": "16.3.0" } } diff --git a/packages/openapi-types-ghec/types.d.ts b/packages/openapi-types-ghec/types.d.ts index e2b1ea5fa..ec4b50d99 100644 --- a/packages/openapi-types-ghec/types.d.ts +++ b/packages/openapi-types-ghec/types.d.ts @@ -10377,6 +10377,21 @@ export interface components { | "pub" | "other" | "swift"; + /** @description A vulnerability describing the product and its affected versions within a GitHub Security Advisory. */ + vulnerability: { + /** @description The name of the package affected by the vulnerability. */ + package: { + ecosystem: components["schemas"]["security-advisory-ecosystems"]; + /** @description The unique package name within its ecosystem. */ + name: string | null; + } | null; + /** @description The range of the package versions affected by the vulnerability. */ + vulnerable_version_range: string | null; + /** @description The package version that resolves the vulnerability. */ + first_patched_version: string | null; + /** @description The functions in the package that are affected by the vulnerability. */ + vulnerable_functions: readonly string[] | null; + }; /** * Simple User * @description A GitHub user. @@ -10537,22 +10552,7 @@ export interface components { */ withdrawn_at: string | null; /** @description The products and respective version ranges affected by the advisory. */ - vulnerabilities: - | { - /** @description The name of the package affected by the vulnerability. */ - package: { - ecosystem: components["schemas"]["security-advisory-ecosystems"]; - /** @description The unique package name within its ecosystem. */ - name: string | null; - } | null; - /** @description The range of the package versions affected by the vulnerability. */ - vulnerable_version_range: string | null; - /** @description The package version that resolve the vulnerability. */ - first_patched_version: string | null; - /** @description The functions in the package that are affected by the vulnerability. */ - vulnerable_functions: readonly string[] | null; - }[] - | null; + vulnerabilities: components["schemas"]["vulnerability"][] | null; cvss: { /** @description The CVSS vector. */ vector_string: string | null; @@ -27743,6 +27743,59 @@ export interface components { /** @example "2020-07-09T00:17:55Z" */ starred_at?: string; }; + /** + * branch protection rule + * @description The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. + */ + webhooks_rule: { + admin_enforced: boolean; + /** @enum {string} */ + allow_deletions_enforcement_level: "off" | "non_admins" | "everyone"; + /** @enum {string} */ + allow_force_pushes_enforcement_level: "off" | "non_admins" | "everyone"; + authorized_actor_names: string[]; + authorized_actors_only: boolean; + authorized_dismissal_actors_only: boolean; + create_protected?: boolean; + /** Format: date-time */ + created_at: string; + dismiss_stale_reviews_on_push: boolean; + id: number; + ignore_approvals_from_contributors: boolean; + /** @enum {string} */ + linear_history_requirement_enforcement_level: + | "off" + | "non_admins" + | "everyone"; + /** @enum {string} */ + merge_queue_enforcement_level: "off" | "non_admins" | "everyone"; + name: string; + /** @enum {string} */ + pull_request_reviews_enforcement_level: "off" | "non_admins" | "everyone"; + repository_id: number; + require_code_owner_review: boolean; + /** @description Whether the most recent push must be approved by someone other than the person who pushed it */ + require_last_push_approval?: boolean; + required_approving_review_count: number; + /** @enum {string} */ + required_conversation_resolution_level: "off" | "non_admins" | "everyone"; + /** @enum {string} */ + required_deployments_enforcement_level: "off" | "non_admins" | "everyone"; + required_status_checks: string[]; + /** @enum {string} */ + required_status_checks_enforcement_level: + | "off" + | "non_admins" + | "everyone"; + /** @enum {string} */ + signature_requirement_enforcement_level: + | "off" + | "non_admins" + | "everyone"; + strict_required_status_checks_policy: boolean; + /** Format: date-time */ + updated_at: string; + }; /** @description A suite of checks performed on the code of a given code change */ "simple-check-suite": { /** @example d6fde92930d4715a2b49857d24b940956b26d2d3 */ @@ -28806,68 +28859,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - /** - * branch protection rule - * @description The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. - */ - rule: { - admin_enforced: boolean; - /** @enum {string} */ - allow_deletions_enforcement_level: "off" | "non_admins" | "everyone"; - /** @enum {string} */ - allow_force_pushes_enforcement_level: "off" | "non_admins" | "everyone"; - authorized_actor_names: string[]; - authorized_actors_only: boolean; - authorized_dismissal_actors_only: boolean; - create_protected?: boolean; - /** Format: date-time */ - created_at: string; - dismiss_stale_reviews_on_push: boolean; - id: number; - ignore_approvals_from_contributors: boolean; - /** @enum {string} */ - linear_history_requirement_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - /** @enum {string} */ - merge_queue_enforcement_level: "off" | "non_admins" | "everyone"; - name: string; - /** @enum {string} */ - pull_request_reviews_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - repository_id: number; - require_code_owner_review: boolean; - /** @description Whether the most recent push must be approved by someone other than the person who pushed it */ - require_last_push_approval?: boolean; - required_approving_review_count: number; - /** @enum {string} */ - required_conversation_resolution_level: - | "off" - | "non_admins" - | "everyone"; - /** @enum {string} */ - required_deployments_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - required_status_checks: string[]; - /** @enum {string} */ - required_status_checks_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - /** @enum {string} */ - signature_requirement_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - strict_required_status_checks_policy: boolean; - /** Format: date-time */ - updated_at: string; - }; + rule: components["schemas"]["webhooks_rule"]; sender: components["schemas"]["simple-user-webhooks"]; }; /** branch protection rule deleted event */ @@ -28878,68 +28870,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - /** - * branch protection rule - * @description The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. - */ - rule: { - admin_enforced: boolean; - /** @enum {string} */ - allow_deletions_enforcement_level: "off" | "non_admins" | "everyone"; - /** @enum {string} */ - allow_force_pushes_enforcement_level: "off" | "non_admins" | "everyone"; - authorized_actor_names: string[]; - authorized_actors_only: boolean; - authorized_dismissal_actors_only: boolean; - create_protected?: boolean; - /** Format: date-time */ - created_at: string; - dismiss_stale_reviews_on_push: boolean; - id: number; - ignore_approvals_from_contributors: boolean; - /** @enum {string} */ - linear_history_requirement_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - /** @enum {string} */ - merge_queue_enforcement_level: "off" | "non_admins" | "everyone"; - name: string; - /** @enum {string} */ - pull_request_reviews_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - repository_id: number; - require_code_owner_review: boolean; - /** @description Whether the most recent push must be approved by someone other than the person who pushed it */ - require_last_push_approval?: boolean; - required_approving_review_count: number; - /** @enum {string} */ - required_conversation_resolution_level: - | "off" - | "non_admins" - | "everyone"; - /** @enum {string} */ - required_deployments_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - required_status_checks: string[]; - /** @enum {string} */ - required_status_checks_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - /** @enum {string} */ - signature_requirement_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - strict_required_status_checks_policy: boolean; - /** Format: date-time */ - updated_at: string; - }; + rule: components["schemas"]["webhooks_rule"]; sender: components["schemas"]["simple-user-webhooks"]; }; /** branch protection rule edited event */ @@ -28976,68 +28907,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - /** - * branch protection rule - * @description The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. - */ - rule: { - admin_enforced: boolean; - /** @enum {string} */ - allow_deletions_enforcement_level: "off" | "non_admins" | "everyone"; - /** @enum {string} */ - allow_force_pushes_enforcement_level: "off" | "non_admins" | "everyone"; - authorized_actor_names: string[]; - authorized_actors_only: boolean; - authorized_dismissal_actors_only: boolean; - create_protected?: boolean; - /** Format: date-time */ - created_at: string; - dismiss_stale_reviews_on_push: boolean; - id: number; - ignore_approvals_from_contributors: boolean; - /** @enum {string} */ - linear_history_requirement_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - /** @enum {string} */ - merge_queue_enforcement_level: "off" | "non_admins" | "everyone"; - name: string; - /** @enum {string} */ - pull_request_reviews_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - repository_id: number; - require_code_owner_review: boolean; - /** @description Whether the most recent push must be approved by someone other than the person who pushed it */ - require_last_push_approval?: boolean; - required_approving_review_count: number; - /** @enum {string} */ - required_conversation_resolution_level: - | "off" - | "non_admins" - | "everyone"; - /** @enum {string} */ - required_deployments_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - required_status_checks: string[]; - /** @enum {string} */ - required_status_checks_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - /** @enum {string} */ - signature_requirement_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - strict_required_status_checks_policy: boolean; - /** Format: date-time */ - updated_at: string; - }; + rule: components["schemas"]["webhooks_rule"]; sender: components["schemas"]["simple-user-webhooks"]; }; /** Check Run Completed Event */ diff --git a/packages/openapi-types-ghes-3.10/package.json b/packages/openapi-types-ghes-3.10/package.json index 9eb3538a4..e897536a5 100644 --- a/packages/openapi-types-ghes-3.10/package.json +++ b/packages/openapi-types-ghes-3.10/package.json @@ -16,6 +16,6 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "octokit": { - "openapi-version": "16.2.0" + "openapi-version": "16.3.0" } } diff --git a/packages/openapi-types-ghes-3.10/types.d.ts b/packages/openapi-types-ghes-3.10/types.d.ts index d6676c0d3..c6c42457a 100644 --- a/packages/openapi-types-ghes-3.10/types.d.ts +++ b/packages/openapi-types-ghes-3.10/types.d.ts @@ -23466,6 +23466,59 @@ export interface components { /** @description Whether anonymous git access is enabled for this repository */ anonymous_access_enabled?: boolean; }; + /** + * branch protection rule + * @description The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-server@3.10/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. + */ + webhooks_rule: { + admin_enforced: boolean; + /** @enum {string} */ + allow_deletions_enforcement_level: "off" | "non_admins" | "everyone"; + /** @enum {string} */ + allow_force_pushes_enforcement_level: "off" | "non_admins" | "everyone"; + authorized_actor_names: string[]; + authorized_actors_only: boolean; + authorized_dismissal_actors_only: boolean; + create_protected?: boolean; + /** Format: date-time */ + created_at: string; + dismiss_stale_reviews_on_push: boolean; + id: number; + ignore_approvals_from_contributors: boolean; + /** @enum {string} */ + linear_history_requirement_enforcement_level: + | "off" + | "non_admins" + | "everyone"; + /** @enum {string} */ + merge_queue_enforcement_level: "off" | "non_admins" | "everyone"; + name: string; + /** @enum {string} */ + pull_request_reviews_enforcement_level: "off" | "non_admins" | "everyone"; + repository_id: number; + require_code_owner_review: boolean; + /** @description Whether the most recent push must be approved by someone other than the person who pushed it */ + require_last_push_approval?: boolean; + required_approving_review_count: number; + /** @enum {string} */ + required_conversation_resolution_level: "off" | "non_admins" | "everyone"; + /** @enum {string} */ + required_deployments_enforcement_level: "off" | "non_admins" | "everyone"; + required_status_checks: string[]; + /** @enum {string} */ + required_status_checks_enforcement_level: + | "off" + | "non_admins" + | "everyone"; + /** @enum {string} */ + signature_requirement_enforcement_level: + | "off" + | "non_admins" + | "everyone"; + strict_required_status_checks_policy: boolean; + /** Format: date-time */ + updated_at: string; + }; /** * Simple User * @description The GitHub user that triggered the event. This property is included in every webhook payload. @@ -24559,68 +24612,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - /** - * branch protection rule - * @description The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-server@3.10/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. - */ - rule: { - admin_enforced: boolean; - /** @enum {string} */ - allow_deletions_enforcement_level: "off" | "non_admins" | "everyone"; - /** @enum {string} */ - allow_force_pushes_enforcement_level: "off" | "non_admins" | "everyone"; - authorized_actor_names: string[]; - authorized_actors_only: boolean; - authorized_dismissal_actors_only: boolean; - create_protected?: boolean; - /** Format: date-time */ - created_at: string; - dismiss_stale_reviews_on_push: boolean; - id: number; - ignore_approvals_from_contributors: boolean; - /** @enum {string} */ - linear_history_requirement_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - /** @enum {string} */ - merge_queue_enforcement_level: "off" | "non_admins" | "everyone"; - name: string; - /** @enum {string} */ - pull_request_reviews_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - repository_id: number; - require_code_owner_review: boolean; - /** @description Whether the most recent push must be approved by someone other than the person who pushed it */ - require_last_push_approval?: boolean; - required_approving_review_count: number; - /** @enum {string} */ - required_conversation_resolution_level: - | "off" - | "non_admins" - | "everyone"; - /** @enum {string} */ - required_deployments_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - required_status_checks: string[]; - /** @enum {string} */ - required_status_checks_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - /** @enum {string} */ - signature_requirement_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - strict_required_status_checks_policy: boolean; - /** Format: date-time */ - updated_at: string; - }; + rule: components["schemas"]["webhooks_rule"]; sender: components["schemas"]["simple-user-webhooks"]; }; /** branch protection rule deleted event */ @@ -24631,68 +24623,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - /** - * branch protection rule - * @description The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-server@3.10/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. - */ - rule: { - admin_enforced: boolean; - /** @enum {string} */ - allow_deletions_enforcement_level: "off" | "non_admins" | "everyone"; - /** @enum {string} */ - allow_force_pushes_enforcement_level: "off" | "non_admins" | "everyone"; - authorized_actor_names: string[]; - authorized_actors_only: boolean; - authorized_dismissal_actors_only: boolean; - create_protected?: boolean; - /** Format: date-time */ - created_at: string; - dismiss_stale_reviews_on_push: boolean; - id: number; - ignore_approvals_from_contributors: boolean; - /** @enum {string} */ - linear_history_requirement_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - /** @enum {string} */ - merge_queue_enforcement_level: "off" | "non_admins" | "everyone"; - name: string; - /** @enum {string} */ - pull_request_reviews_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - repository_id: number; - require_code_owner_review: boolean; - /** @description Whether the most recent push must be approved by someone other than the person who pushed it */ - require_last_push_approval?: boolean; - required_approving_review_count: number; - /** @enum {string} */ - required_conversation_resolution_level: - | "off" - | "non_admins" - | "everyone"; - /** @enum {string} */ - required_deployments_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - required_status_checks: string[]; - /** @enum {string} */ - required_status_checks_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - /** @enum {string} */ - signature_requirement_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - strict_required_status_checks_policy: boolean; - /** Format: date-time */ - updated_at: string; - }; + rule: components["schemas"]["webhooks_rule"]; sender: components["schemas"]["simple-user-webhooks"]; }; /** branch protection rule edited event */ @@ -24729,68 +24660,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - /** - * branch protection rule - * @description The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-server@3.10/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. - */ - rule: { - admin_enforced: boolean; - /** @enum {string} */ - allow_deletions_enforcement_level: "off" | "non_admins" | "everyone"; - /** @enum {string} */ - allow_force_pushes_enforcement_level: "off" | "non_admins" | "everyone"; - authorized_actor_names: string[]; - authorized_actors_only: boolean; - authorized_dismissal_actors_only: boolean; - create_protected?: boolean; - /** Format: date-time */ - created_at: string; - dismiss_stale_reviews_on_push: boolean; - id: number; - ignore_approvals_from_contributors: boolean; - /** @enum {string} */ - linear_history_requirement_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - /** @enum {string} */ - merge_queue_enforcement_level: "off" | "non_admins" | "everyone"; - name: string; - /** @enum {string} */ - pull_request_reviews_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - repository_id: number; - require_code_owner_review: boolean; - /** @description Whether the most recent push must be approved by someone other than the person who pushed it */ - require_last_push_approval?: boolean; - required_approving_review_count: number; - /** @enum {string} */ - required_conversation_resolution_level: - | "off" - | "non_admins" - | "everyone"; - /** @enum {string} */ - required_deployments_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - required_status_checks: string[]; - /** @enum {string} */ - required_status_checks_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - /** @enum {string} */ - signature_requirement_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - strict_required_status_checks_policy: boolean; - /** Format: date-time */ - updated_at: string; - }; + rule: components["schemas"]["webhooks_rule"]; sender: components["schemas"]["simple-user-webhooks"]; }; "webhook-cache-sync": { diff --git a/packages/openapi-types-ghes-3.11/package.json b/packages/openapi-types-ghes-3.11/package.json index 165535e32..7a4ed1093 100644 --- a/packages/openapi-types-ghes-3.11/package.json +++ b/packages/openapi-types-ghes-3.11/package.json @@ -16,6 +16,6 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "octokit": { - "openapi-version": "16.2.0" + "openapi-version": "16.3.0" } } diff --git a/packages/openapi-types-ghes-3.11/types.d.ts b/packages/openapi-types-ghes-3.11/types.d.ts index 7774598e1..ca0f459bc 100644 --- a/packages/openapi-types-ghes-3.11/types.d.ts +++ b/packages/openapi-types-ghes-3.11/types.d.ts @@ -9781,6 +9781,21 @@ export interface components { | "pub" | "other" | "swift"; + /** @description A vulnerability describing the product and its affected versions within a GitHub Security Advisory. */ + vulnerability: { + /** @description The name of the package affected by the vulnerability. */ + package: { + ecosystem: components["schemas"]["security-advisory-ecosystems"]; + /** @description The unique package name within its ecosystem. */ + name: string | null; + } | null; + /** @description The range of the package versions affected by the vulnerability. */ + vulnerable_version_range: string | null; + /** @description The package version that resolves the vulnerability. */ + first_patched_version: string | null; + /** @description The functions in the package that are affected by the vulnerability. */ + vulnerable_functions: readonly string[] | null; + }; /** * @description The type of credit the user is receiving. * @enum {string} @@ -9872,22 +9887,7 @@ export interface components { */ withdrawn_at: string | null; /** @description The products and respective version ranges affected by the advisory. */ - vulnerabilities: - | { - /** @description The name of the package affected by the vulnerability. */ - package: { - ecosystem: components["schemas"]["security-advisory-ecosystems"]; - /** @description The unique package name within its ecosystem. */ - name: string | null; - } | null; - /** @description The range of the package versions affected by the vulnerability. */ - vulnerable_version_range: string | null; - /** @description The package version that resolve the vulnerability. */ - first_patched_version: string | null; - /** @description The functions in the package that are affected by the vulnerability. */ - vulnerable_functions: readonly string[] | null; - }[] - | null; + vulnerabilities: components["schemas"]["vulnerability"][] | null; cvss: { /** @description The CVSS vector. */ vector_string: string | null; @@ -24307,6 +24307,59 @@ export interface components { /** @example "2020-07-09T00:17:55Z" */ starred_at?: string; }; + /** + * branch protection rule + * @description The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-server@3.11/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. + */ + webhooks_rule: { + admin_enforced: boolean; + /** @enum {string} */ + allow_deletions_enforcement_level: "off" | "non_admins" | "everyone"; + /** @enum {string} */ + allow_force_pushes_enforcement_level: "off" | "non_admins" | "everyone"; + authorized_actor_names: string[]; + authorized_actors_only: boolean; + authorized_dismissal_actors_only: boolean; + create_protected?: boolean; + /** Format: date-time */ + created_at: string; + dismiss_stale_reviews_on_push: boolean; + id: number; + ignore_approvals_from_contributors: boolean; + /** @enum {string} */ + linear_history_requirement_enforcement_level: + | "off" + | "non_admins" + | "everyone"; + /** @enum {string} */ + merge_queue_enforcement_level: "off" | "non_admins" | "everyone"; + name: string; + /** @enum {string} */ + pull_request_reviews_enforcement_level: "off" | "non_admins" | "everyone"; + repository_id: number; + require_code_owner_review: boolean; + /** @description Whether the most recent push must be approved by someone other than the person who pushed it */ + require_last_push_approval?: boolean; + required_approving_review_count: number; + /** @enum {string} */ + required_conversation_resolution_level: "off" | "non_admins" | "everyone"; + /** @enum {string} */ + required_deployments_enforcement_level: "off" | "non_admins" | "everyone"; + required_status_checks: string[]; + /** @enum {string} */ + required_status_checks_enforcement_level: + | "off" + | "non_admins" + | "everyone"; + /** @enum {string} */ + signature_requirement_enforcement_level: + | "off" + | "non_admins" + | "everyone"; + strict_required_status_checks_policy: boolean; + /** Format: date-time */ + updated_at: string; + }; /** @description A suite of checks performed on the code of a given code change */ "simple-check-suite": { /** @example d6fde92930d4715a2b49857d24b940956b26d2d3 */ @@ -25351,68 +25404,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - /** - * branch protection rule - * @description The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-server@3.11/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. - */ - rule: { - admin_enforced: boolean; - /** @enum {string} */ - allow_deletions_enforcement_level: "off" | "non_admins" | "everyone"; - /** @enum {string} */ - allow_force_pushes_enforcement_level: "off" | "non_admins" | "everyone"; - authorized_actor_names: string[]; - authorized_actors_only: boolean; - authorized_dismissal_actors_only: boolean; - create_protected?: boolean; - /** Format: date-time */ - created_at: string; - dismiss_stale_reviews_on_push: boolean; - id: number; - ignore_approvals_from_contributors: boolean; - /** @enum {string} */ - linear_history_requirement_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - /** @enum {string} */ - merge_queue_enforcement_level: "off" | "non_admins" | "everyone"; - name: string; - /** @enum {string} */ - pull_request_reviews_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - repository_id: number; - require_code_owner_review: boolean; - /** @description Whether the most recent push must be approved by someone other than the person who pushed it */ - require_last_push_approval?: boolean; - required_approving_review_count: number; - /** @enum {string} */ - required_conversation_resolution_level: - | "off" - | "non_admins" - | "everyone"; - /** @enum {string} */ - required_deployments_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - required_status_checks: string[]; - /** @enum {string} */ - required_status_checks_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - /** @enum {string} */ - signature_requirement_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - strict_required_status_checks_policy: boolean; - /** Format: date-time */ - updated_at: string; - }; + rule: components["schemas"]["webhooks_rule"]; sender: components["schemas"]["simple-user-webhooks"]; }; /** branch protection rule deleted event */ @@ -25423,68 +25415,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - /** - * branch protection rule - * @description The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-server@3.11/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. - */ - rule: { - admin_enforced: boolean; - /** @enum {string} */ - allow_deletions_enforcement_level: "off" | "non_admins" | "everyone"; - /** @enum {string} */ - allow_force_pushes_enforcement_level: "off" | "non_admins" | "everyone"; - authorized_actor_names: string[]; - authorized_actors_only: boolean; - authorized_dismissal_actors_only: boolean; - create_protected?: boolean; - /** Format: date-time */ - created_at: string; - dismiss_stale_reviews_on_push: boolean; - id: number; - ignore_approvals_from_contributors: boolean; - /** @enum {string} */ - linear_history_requirement_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - /** @enum {string} */ - merge_queue_enforcement_level: "off" | "non_admins" | "everyone"; - name: string; - /** @enum {string} */ - pull_request_reviews_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - repository_id: number; - require_code_owner_review: boolean; - /** @description Whether the most recent push must be approved by someone other than the person who pushed it */ - require_last_push_approval?: boolean; - required_approving_review_count: number; - /** @enum {string} */ - required_conversation_resolution_level: - | "off" - | "non_admins" - | "everyone"; - /** @enum {string} */ - required_deployments_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - required_status_checks: string[]; - /** @enum {string} */ - required_status_checks_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - /** @enum {string} */ - signature_requirement_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - strict_required_status_checks_policy: boolean; - /** Format: date-time */ - updated_at: string; - }; + rule: components["schemas"]["webhooks_rule"]; sender: components["schemas"]["simple-user-webhooks"]; }; /** branch protection rule edited event */ @@ -25521,68 +25452,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - /** - * branch protection rule - * @description The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-server@3.11/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. - */ - rule: { - admin_enforced: boolean; - /** @enum {string} */ - allow_deletions_enforcement_level: "off" | "non_admins" | "everyone"; - /** @enum {string} */ - allow_force_pushes_enforcement_level: "off" | "non_admins" | "everyone"; - authorized_actor_names: string[]; - authorized_actors_only: boolean; - authorized_dismissal_actors_only: boolean; - create_protected?: boolean; - /** Format: date-time */ - created_at: string; - dismiss_stale_reviews_on_push: boolean; - id: number; - ignore_approvals_from_contributors: boolean; - /** @enum {string} */ - linear_history_requirement_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - /** @enum {string} */ - merge_queue_enforcement_level: "off" | "non_admins" | "everyone"; - name: string; - /** @enum {string} */ - pull_request_reviews_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - repository_id: number; - require_code_owner_review: boolean; - /** @description Whether the most recent push must be approved by someone other than the person who pushed it */ - require_last_push_approval?: boolean; - required_approving_review_count: number; - /** @enum {string} */ - required_conversation_resolution_level: - | "off" - | "non_admins" - | "everyone"; - /** @enum {string} */ - required_deployments_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - required_status_checks: string[]; - /** @enum {string} */ - required_status_checks_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - /** @enum {string} */ - signature_requirement_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - strict_required_status_checks_policy: boolean; - /** Format: date-time */ - updated_at: string; - }; + rule: components["schemas"]["webhooks_rule"]; sender: components["schemas"]["simple-user-webhooks"]; }; "webhook-cache-sync": { diff --git a/packages/openapi-types-ghes-3.12/package.json b/packages/openapi-types-ghes-3.12/package.json index e1eb65fd4..71f3438b0 100644 --- a/packages/openapi-types-ghes-3.12/package.json +++ b/packages/openapi-types-ghes-3.12/package.json @@ -16,6 +16,6 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "octokit": { - "openapi-version": "16.2.0" + "openapi-version": "16.3.0" } } diff --git a/packages/openapi-types-ghes-3.12/types.d.ts b/packages/openapi-types-ghes-3.12/types.d.ts index c9eedbe2f..0eb6bb8d6 100644 --- a/packages/openapi-types-ghes-3.12/types.d.ts +++ b/packages/openapi-types-ghes-3.12/types.d.ts @@ -1243,6 +1243,26 @@ export interface paths { */ get: operations["enterprise-admin/get-checks-system-requirements"]; }; + "/manage/v1/config/apply": { + /** + * Get the status of a ghe-config-apply run + * @description Displays the current status of `ghe-config-apply` in the environment or the status of a historical run by ID. + */ + get: operations["enterprise-admin/get-manage-settings"]; + /** + * Trigger a ghe-config-apply run + * @description Triggers a run of `ghe-config-apply` from the `ghes-manage` agent on your Nomad Delegate instance. + * You can provide a run ID or allow one to be generated randomly. + */ + post: operations["enterprise-admin/get-manage-settings"]; + }; + "/manage/v1/config/apply/events": { + /** + * List events from ghe-config-apply + * @description Lists events from an in-process `ghe-config-apply` run on your Github Enterprise Server instance. + */ + get: operations["enterprise-admin/get-manage-settings"]; + }; "/manage/v1/config/init": { /** * Initialize instance configuration with license upload @@ -9906,6 +9926,21 @@ export interface components { | "pub" | "other" | "swift"; + /** @description A vulnerability describing the product and its affected versions within a GitHub Security Advisory. */ + vulnerability: { + /** @description The name of the package affected by the vulnerability. */ + package: { + ecosystem: components["schemas"]["security-advisory-ecosystems"]; + /** @description The unique package name within its ecosystem. */ + name: string | null; + } | null; + /** @description The range of the package versions affected by the vulnerability. */ + vulnerable_version_range: string | null; + /** @description The package version that resolves the vulnerability. */ + first_patched_version: string | null; + /** @description The functions in the package that are affected by the vulnerability. */ + vulnerable_functions: readonly string[] | null; + }; /** * @description The type of credit the user is receiving. * @enum {string} @@ -9997,22 +10032,7 @@ export interface components { */ withdrawn_at: string | null; /** @description The products and respective version ranges affected by the advisory. */ - vulnerabilities: - | { - /** @description The name of the package affected by the vulnerability. */ - package: { - ecosystem: components["schemas"]["security-advisory-ecosystems"]; - /** @description The unique package name within its ecosystem. */ - name: string | null; - } | null; - /** @description The range of the package versions affected by the vulnerability. */ - vulnerable_version_range: string | null; - /** @description The package version that resolve the vulnerability. */ - first_patched_version: string | null; - /** @description The functions in the package that are affected by the vulnerability. */ - vulnerable_functions: readonly string[] | null; - }[] - | null; + vulnerabilities: components["schemas"]["vulnerability"][] | null; cvss: { /** @description The CVSS vector. */ vector_string: string | null; @@ -24840,6 +24860,59 @@ export interface components { /** @example "2020-07-09T00:17:55Z" */ starred_at?: string; }; + /** + * branch protection rule + * @description The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-server@3.12/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. + */ + webhooks_rule: { + admin_enforced: boolean; + /** @enum {string} */ + allow_deletions_enforcement_level: "off" | "non_admins" | "everyone"; + /** @enum {string} */ + allow_force_pushes_enforcement_level: "off" | "non_admins" | "everyone"; + authorized_actor_names: string[]; + authorized_actors_only: boolean; + authorized_dismissal_actors_only: boolean; + create_protected?: boolean; + /** Format: date-time */ + created_at: string; + dismiss_stale_reviews_on_push: boolean; + id: number; + ignore_approvals_from_contributors: boolean; + /** @enum {string} */ + linear_history_requirement_enforcement_level: + | "off" + | "non_admins" + | "everyone"; + /** @enum {string} */ + merge_queue_enforcement_level: "off" | "non_admins" | "everyone"; + name: string; + /** @enum {string} */ + pull_request_reviews_enforcement_level: "off" | "non_admins" | "everyone"; + repository_id: number; + require_code_owner_review: boolean; + /** @description Whether the most recent push must be approved by someone other than the person who pushed it */ + require_last_push_approval?: boolean; + required_approving_review_count: number; + /** @enum {string} */ + required_conversation_resolution_level: "off" | "non_admins" | "everyone"; + /** @enum {string} */ + required_deployments_enforcement_level: "off" | "non_admins" | "everyone"; + required_status_checks: string[]; + /** @enum {string} */ + required_status_checks_enforcement_level: + | "off" + | "non_admins" + | "everyone"; + /** @enum {string} */ + signature_requirement_enforcement_level: + | "off" + | "non_admins" + | "everyone"; + strict_required_status_checks_policy: boolean; + /** Format: date-time */ + updated_at: string; + }; /** @description A suite of checks performed on the code of a given code change */ "simple-check-suite": { /** @example d6fde92930d4715a2b49857d24b940956b26d2d3 */ @@ -25884,68 +25957,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - /** - * branch protection rule - * @description The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-server@3.12/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. - */ - rule: { - admin_enforced: boolean; - /** @enum {string} */ - allow_deletions_enforcement_level: "off" | "non_admins" | "everyone"; - /** @enum {string} */ - allow_force_pushes_enforcement_level: "off" | "non_admins" | "everyone"; - authorized_actor_names: string[]; - authorized_actors_only: boolean; - authorized_dismissal_actors_only: boolean; - create_protected?: boolean; - /** Format: date-time */ - created_at: string; - dismiss_stale_reviews_on_push: boolean; - id: number; - ignore_approvals_from_contributors: boolean; - /** @enum {string} */ - linear_history_requirement_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - /** @enum {string} */ - merge_queue_enforcement_level: "off" | "non_admins" | "everyone"; - name: string; - /** @enum {string} */ - pull_request_reviews_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - repository_id: number; - require_code_owner_review: boolean; - /** @description Whether the most recent push must be approved by someone other than the person who pushed it */ - require_last_push_approval?: boolean; - required_approving_review_count: number; - /** @enum {string} */ - required_conversation_resolution_level: - | "off" - | "non_admins" - | "everyone"; - /** @enum {string} */ - required_deployments_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - required_status_checks: string[]; - /** @enum {string} */ - required_status_checks_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - /** @enum {string} */ - signature_requirement_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - strict_required_status_checks_policy: boolean; - /** Format: date-time */ - updated_at: string; - }; + rule: components["schemas"]["webhooks_rule"]; sender: components["schemas"]["simple-user-webhooks"]; }; /** branch protection rule deleted event */ @@ -25956,68 +25968,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - /** - * branch protection rule - * @description The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-server@3.12/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. - */ - rule: { - admin_enforced: boolean; - /** @enum {string} */ - allow_deletions_enforcement_level: "off" | "non_admins" | "everyone"; - /** @enum {string} */ - allow_force_pushes_enforcement_level: "off" | "non_admins" | "everyone"; - authorized_actor_names: string[]; - authorized_actors_only: boolean; - authorized_dismissal_actors_only: boolean; - create_protected?: boolean; - /** Format: date-time */ - created_at: string; - dismiss_stale_reviews_on_push: boolean; - id: number; - ignore_approvals_from_contributors: boolean; - /** @enum {string} */ - linear_history_requirement_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - /** @enum {string} */ - merge_queue_enforcement_level: "off" | "non_admins" | "everyone"; - name: string; - /** @enum {string} */ - pull_request_reviews_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - repository_id: number; - require_code_owner_review: boolean; - /** @description Whether the most recent push must be approved by someone other than the person who pushed it */ - require_last_push_approval?: boolean; - required_approving_review_count: number; - /** @enum {string} */ - required_conversation_resolution_level: - | "off" - | "non_admins" - | "everyone"; - /** @enum {string} */ - required_deployments_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - required_status_checks: string[]; - /** @enum {string} */ - required_status_checks_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - /** @enum {string} */ - signature_requirement_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - strict_required_status_checks_policy: boolean; - /** Format: date-time */ - updated_at: string; - }; + rule: components["schemas"]["webhooks_rule"]; sender: components["schemas"]["simple-user-webhooks"]; }; /** branch protection rule edited event */ @@ -26054,68 +26005,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - /** - * branch protection rule - * @description The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-server@3.12/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. - */ - rule: { - admin_enforced: boolean; - /** @enum {string} */ - allow_deletions_enforcement_level: "off" | "non_admins" | "everyone"; - /** @enum {string} */ - allow_force_pushes_enforcement_level: "off" | "non_admins" | "everyone"; - authorized_actor_names: string[]; - authorized_actors_only: boolean; - authorized_dismissal_actors_only: boolean; - create_protected?: boolean; - /** Format: date-time */ - created_at: string; - dismiss_stale_reviews_on_push: boolean; - id: number; - ignore_approvals_from_contributors: boolean; - /** @enum {string} */ - linear_history_requirement_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - /** @enum {string} */ - merge_queue_enforcement_level: "off" | "non_admins" | "everyone"; - name: string; - /** @enum {string} */ - pull_request_reviews_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - repository_id: number; - require_code_owner_review: boolean; - /** @description Whether the most recent push must be approved by someone other than the person who pushed it */ - require_last_push_approval?: boolean; - required_approving_review_count: number; - /** @enum {string} */ - required_conversation_resolution_level: - | "off" - | "non_admins" - | "everyone"; - /** @enum {string} */ - required_deployments_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - required_status_checks: string[]; - /** @enum {string} */ - required_status_checks_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - /** @enum {string} */ - signature_requirement_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - strict_required_status_checks_policy: boolean; - /** Format: date-time */ - updated_at: string; - }; + rule: components["schemas"]["webhooks_rule"]; sender: components["schemas"]["simple-user-webhooks"]; }; "webhook-cache-sync": { @@ -87751,6 +87641,28 @@ export interface operations { }; }; }; + /** + * Get the GHES settings + * @description Gets a list of settings for a GitHub Enterprise Server instance. + */ + "enterprise-admin/get-manage-settings": { + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["ghes-get-settings"]; + }; + }; + /** @description Bad request */ + 400: { + content: never; + }; + /** @description Unauthorized */ + 401: { + content: never; + }; + }; + }; /** * Initialize instance configuration with license upload * @description When you boot a GitHub instance for the first time, you can use this endpoint to upload a license. @@ -87893,28 +87805,6 @@ export interface operations { }; }; }; - /** - * Get the GHES settings - * @description Gets a list of settings for a GitHub Enterprise Server instance. - */ - "enterprise-admin/get-manage-settings": { - responses: { - /** @description Response */ - 200: { - content: { - "application/json": components["schemas"]["ghes-get-settings"]; - }; - }; - /** @description Bad request */ - 400: { - content: never; - }; - /** @description Unauthorized */ - 401: { - content: never; - }; - }; - }; /** * Set settings * @description Updates the settings on your instance. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#get-settings). diff --git a/packages/openapi-types-ghes-3.9/package.json b/packages/openapi-types-ghes-3.9/package.json index c573ceb3d..9b3dddf3c 100644 --- a/packages/openapi-types-ghes-3.9/package.json +++ b/packages/openapi-types-ghes-3.9/package.json @@ -16,6 +16,6 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "octokit": { - "openapi-version": "16.2.0" + "openapi-version": "16.3.0" } } diff --git a/packages/openapi-types-ghes-3.9/types.d.ts b/packages/openapi-types-ghes-3.9/types.d.ts index 3b3c07b71..574debaed 100644 --- a/packages/openapi-types-ghes-3.9/types.d.ts +++ b/packages/openapi-types-ghes-3.9/types.d.ts @@ -23020,6 +23020,57 @@ export interface components { /** @description Whether anonymous git access is enabled for this repository */ anonymous_access_enabled?: boolean; }; + /** + * branch protection rule + * @description The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-server@3.9/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. + */ + webhooks_rule: { + admin_enforced: boolean; + /** @enum {string} */ + allow_deletions_enforcement_level: "off" | "non_admins" | "everyone"; + /** @enum {string} */ + allow_force_pushes_enforcement_level: "off" | "non_admins" | "everyone"; + authorized_actor_names: string[]; + authorized_actors_only: boolean; + authorized_dismissal_actors_only: boolean; + create_protected?: boolean; + /** Format: date-time */ + created_at: string; + dismiss_stale_reviews_on_push: boolean; + id: number; + ignore_approvals_from_contributors: boolean; + /** @enum {string} */ + linear_history_requirement_enforcement_level: + | "off" + | "non_admins" + | "everyone"; + /** @enum {string} */ + merge_queue_enforcement_level: "off" | "non_admins" | "everyone"; + name: string; + /** @enum {string} */ + pull_request_reviews_enforcement_level: "off" | "non_admins" | "everyone"; + repository_id: number; + require_code_owner_review: boolean; + required_approving_review_count: number; + /** @enum {string} */ + required_conversation_resolution_level: "off" | "non_admins" | "everyone"; + /** @enum {string} */ + required_deployments_enforcement_level: "off" | "non_admins" | "everyone"; + required_status_checks: string[]; + /** @enum {string} */ + required_status_checks_enforcement_level: + | "off" + | "non_admins" + | "everyone"; + /** @enum {string} */ + signature_requirement_enforcement_level: + | "off" + | "non_admins" + | "everyone"; + strict_required_status_checks_policy: boolean; + /** Format: date-time */ + updated_at: string; + }; /** * Simple User * @description The GitHub user that triggered the event. This property is included in every webhook payload. @@ -24040,66 +24091,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - /** - * branch protection rule - * @description The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-server@3.9/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. - */ - rule: { - admin_enforced: boolean; - /** @enum {string} */ - allow_deletions_enforcement_level: "off" | "non_admins" | "everyone"; - /** @enum {string} */ - allow_force_pushes_enforcement_level: "off" | "non_admins" | "everyone"; - authorized_actor_names: string[]; - authorized_actors_only: boolean; - authorized_dismissal_actors_only: boolean; - create_protected?: boolean; - /** Format: date-time */ - created_at: string; - dismiss_stale_reviews_on_push: boolean; - id: number; - ignore_approvals_from_contributors: boolean; - /** @enum {string} */ - linear_history_requirement_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - /** @enum {string} */ - merge_queue_enforcement_level: "off" | "non_admins" | "everyone"; - name: string; - /** @enum {string} */ - pull_request_reviews_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - repository_id: number; - require_code_owner_review: boolean; - required_approving_review_count: number; - /** @enum {string} */ - required_conversation_resolution_level: - | "off" - | "non_admins" - | "everyone"; - /** @enum {string} */ - required_deployments_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - required_status_checks: string[]; - /** @enum {string} */ - required_status_checks_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - /** @enum {string} */ - signature_requirement_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - strict_required_status_checks_policy: boolean; - /** Format: date-time */ - updated_at: string; - }; + rule: components["schemas"]["webhooks_rule"]; sender: components["schemas"]["simple-user-webhooks"]; }; /** branch protection rule deleted event */ @@ -24110,66 +24102,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - /** - * branch protection rule - * @description The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-server@3.9/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. - */ - rule: { - admin_enforced: boolean; - /** @enum {string} */ - allow_deletions_enforcement_level: "off" | "non_admins" | "everyone"; - /** @enum {string} */ - allow_force_pushes_enforcement_level: "off" | "non_admins" | "everyone"; - authorized_actor_names: string[]; - authorized_actors_only: boolean; - authorized_dismissal_actors_only: boolean; - create_protected?: boolean; - /** Format: date-time */ - created_at: string; - dismiss_stale_reviews_on_push: boolean; - id: number; - ignore_approvals_from_contributors: boolean; - /** @enum {string} */ - linear_history_requirement_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - /** @enum {string} */ - merge_queue_enforcement_level: "off" | "non_admins" | "everyone"; - name: string; - /** @enum {string} */ - pull_request_reviews_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - repository_id: number; - require_code_owner_review: boolean; - required_approving_review_count: number; - /** @enum {string} */ - required_conversation_resolution_level: - | "off" - | "non_admins" - | "everyone"; - /** @enum {string} */ - required_deployments_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - required_status_checks: string[]; - /** @enum {string} */ - required_status_checks_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - /** @enum {string} */ - signature_requirement_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - strict_required_status_checks_policy: boolean; - /** Format: date-time */ - updated_at: string; - }; + rule: components["schemas"]["webhooks_rule"]; sender: components["schemas"]["simple-user-webhooks"]; }; /** branch protection rule edited event */ @@ -24206,66 +24139,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - /** - * branch protection rule - * @description The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-server@3.9/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. - */ - rule: { - admin_enforced: boolean; - /** @enum {string} */ - allow_deletions_enforcement_level: "off" | "non_admins" | "everyone"; - /** @enum {string} */ - allow_force_pushes_enforcement_level: "off" | "non_admins" | "everyone"; - authorized_actor_names: string[]; - authorized_actors_only: boolean; - authorized_dismissal_actors_only: boolean; - create_protected?: boolean; - /** Format: date-time */ - created_at: string; - dismiss_stale_reviews_on_push: boolean; - id: number; - ignore_approvals_from_contributors: boolean; - /** @enum {string} */ - linear_history_requirement_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - /** @enum {string} */ - merge_queue_enforcement_level: "off" | "non_admins" | "everyone"; - name: string; - /** @enum {string} */ - pull_request_reviews_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - repository_id: number; - require_code_owner_review: boolean; - required_approving_review_count: number; - /** @enum {string} */ - required_conversation_resolution_level: - | "off" - | "non_admins" - | "everyone"; - /** @enum {string} */ - required_deployments_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - required_status_checks: string[]; - /** @enum {string} */ - required_status_checks_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - /** @enum {string} */ - signature_requirement_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - strict_required_status_checks_policy: boolean; - /** Format: date-time */ - updated_at: string; - }; + rule: components["schemas"]["webhooks_rule"]; sender: components["schemas"]["simple-user-webhooks"]; }; "webhook-cache-sync": { diff --git a/packages/openapi-types-github.ae/package.json b/packages/openapi-types-github.ae/package.json index 7e5d867cd..5732d1cf1 100644 --- a/packages/openapi-types-github.ae/package.json +++ b/packages/openapi-types-github.ae/package.json @@ -16,6 +16,6 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "octokit": { - "openapi-version": "16.2.0" + "openapi-version": "16.3.0" } } diff --git a/packages/openapi-types/package.json b/packages/openapi-types/package.json index 1397766bd..77636c453 100644 --- a/packages/openapi-types/package.json +++ b/packages/openapi-types/package.json @@ -16,6 +16,6 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "octokit": { - "openapi-version": "16.2.0" + "openapi-version": "16.3.0" } } diff --git a/packages/openapi-types/types.d.ts b/packages/openapi-types/types.d.ts index 106478828..f0fad35df 100644 --- a/packages/openapi-types/types.d.ts +++ b/packages/openapi-types/types.d.ts @@ -9296,6 +9296,21 @@ export interface components { | "pub" | "other" | "swift"; + /** @description A vulnerability describing the product and its affected versions within a GitHub Security Advisory. */ + vulnerability: { + /** @description The name of the package affected by the vulnerability. */ + package: { + ecosystem: components["schemas"]["security-advisory-ecosystems"]; + /** @description The unique package name within its ecosystem. */ + name: string | null; + } | null; + /** @description The range of the package versions affected by the vulnerability. */ + vulnerable_version_range: string | null; + /** @description The package version that resolves the vulnerability. */ + first_patched_version: string | null; + /** @description The functions in the package that are affected by the vulnerability. */ + vulnerable_functions: readonly string[] | null; + }; /** * Simple User * @description A GitHub user. @@ -9456,22 +9471,7 @@ export interface components { */ withdrawn_at: string | null; /** @description The products and respective version ranges affected by the advisory. */ - vulnerabilities: - | { - /** @description The name of the package affected by the vulnerability. */ - package: { - ecosystem: components["schemas"]["security-advisory-ecosystems"]; - /** @description The unique package name within its ecosystem. */ - name: string | null; - } | null; - /** @description The range of the package versions affected by the vulnerability. */ - vulnerable_version_range: string | null; - /** @description The package version that resolve the vulnerability. */ - first_patched_version: string | null; - /** @description The functions in the package that are affected by the vulnerability. */ - vulnerable_functions: readonly string[] | null; - }[] - | null; + vulnerabilities: components["schemas"]["vulnerability"][] | null; cvss: { /** @description The CVSS vector. */ vector_string: string | null; @@ -25470,6 +25470,59 @@ export interface components { /** @example "2020-07-09T00:17:55Z" */ starred_at?: string; }; + /** + * branch protection rule + * @description The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. + */ + webhooks_rule: { + admin_enforced: boolean; + /** @enum {string} */ + allow_deletions_enforcement_level: "off" | "non_admins" | "everyone"; + /** @enum {string} */ + allow_force_pushes_enforcement_level: "off" | "non_admins" | "everyone"; + authorized_actor_names: string[]; + authorized_actors_only: boolean; + authorized_dismissal_actors_only: boolean; + create_protected?: boolean; + /** Format: date-time */ + created_at: string; + dismiss_stale_reviews_on_push: boolean; + id: number; + ignore_approvals_from_contributors: boolean; + /** @enum {string} */ + linear_history_requirement_enforcement_level: + | "off" + | "non_admins" + | "everyone"; + /** @enum {string} */ + merge_queue_enforcement_level: "off" | "non_admins" | "everyone"; + name: string; + /** @enum {string} */ + pull_request_reviews_enforcement_level: "off" | "non_admins" | "everyone"; + repository_id: number; + require_code_owner_review: boolean; + /** @description Whether the most recent push must be approved by someone other than the person who pushed it */ + require_last_push_approval?: boolean; + required_approving_review_count: number; + /** @enum {string} */ + required_conversation_resolution_level: "off" | "non_admins" | "everyone"; + /** @enum {string} */ + required_deployments_enforcement_level: "off" | "non_admins" | "everyone"; + required_status_checks: string[]; + /** @enum {string} */ + required_status_checks_enforcement_level: + | "off" + | "non_admins" + | "everyone"; + /** @enum {string} */ + signature_requirement_enforcement_level: + | "off" + | "non_admins" + | "everyone"; + strict_required_status_checks_policy: boolean; + /** Format: date-time */ + updated_at: string; + }; /** @description A suite of checks performed on the code of a given code change */ "simple-check-suite": { /** @example d6fde92930d4715a2b49857d24b940956b26d2d3 */ @@ -26533,68 +26586,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - /** - * branch protection rule - * @description The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. - */ - rule: { - admin_enforced: boolean; - /** @enum {string} */ - allow_deletions_enforcement_level: "off" | "non_admins" | "everyone"; - /** @enum {string} */ - allow_force_pushes_enforcement_level: "off" | "non_admins" | "everyone"; - authorized_actor_names: string[]; - authorized_actors_only: boolean; - authorized_dismissal_actors_only: boolean; - create_protected?: boolean; - /** Format: date-time */ - created_at: string; - dismiss_stale_reviews_on_push: boolean; - id: number; - ignore_approvals_from_contributors: boolean; - /** @enum {string} */ - linear_history_requirement_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - /** @enum {string} */ - merge_queue_enforcement_level: "off" | "non_admins" | "everyone"; - name: string; - /** @enum {string} */ - pull_request_reviews_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - repository_id: number; - require_code_owner_review: boolean; - /** @description Whether the most recent push must be approved by someone other than the person who pushed it */ - require_last_push_approval?: boolean; - required_approving_review_count: number; - /** @enum {string} */ - required_conversation_resolution_level: - | "off" - | "non_admins" - | "everyone"; - /** @enum {string} */ - required_deployments_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - required_status_checks: string[]; - /** @enum {string} */ - required_status_checks_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - /** @enum {string} */ - signature_requirement_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - strict_required_status_checks_policy: boolean; - /** Format: date-time */ - updated_at: string; - }; + rule: components["schemas"]["webhooks_rule"]; sender: components["schemas"]["simple-user-webhooks"]; }; /** branch protection rule deleted event */ @@ -26605,68 +26597,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - /** - * branch protection rule - * @description The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. - */ - rule: { - admin_enforced: boolean; - /** @enum {string} */ - allow_deletions_enforcement_level: "off" | "non_admins" | "everyone"; - /** @enum {string} */ - allow_force_pushes_enforcement_level: "off" | "non_admins" | "everyone"; - authorized_actor_names: string[]; - authorized_actors_only: boolean; - authorized_dismissal_actors_only: boolean; - create_protected?: boolean; - /** Format: date-time */ - created_at: string; - dismiss_stale_reviews_on_push: boolean; - id: number; - ignore_approvals_from_contributors: boolean; - /** @enum {string} */ - linear_history_requirement_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - /** @enum {string} */ - merge_queue_enforcement_level: "off" | "non_admins" | "everyone"; - name: string; - /** @enum {string} */ - pull_request_reviews_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - repository_id: number; - require_code_owner_review: boolean; - /** @description Whether the most recent push must be approved by someone other than the person who pushed it */ - require_last_push_approval?: boolean; - required_approving_review_count: number; - /** @enum {string} */ - required_conversation_resolution_level: - | "off" - | "non_admins" - | "everyone"; - /** @enum {string} */ - required_deployments_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - required_status_checks: string[]; - /** @enum {string} */ - required_status_checks_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - /** @enum {string} */ - signature_requirement_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - strict_required_status_checks_policy: boolean; - /** Format: date-time */ - updated_at: string; - }; + rule: components["schemas"]["webhooks_rule"]; sender: components["schemas"]["simple-user-webhooks"]; }; /** branch protection rule edited event */ @@ -26703,68 +26634,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - /** - * branch protection rule - * @description The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. - */ - rule: { - admin_enforced: boolean; - /** @enum {string} */ - allow_deletions_enforcement_level: "off" | "non_admins" | "everyone"; - /** @enum {string} */ - allow_force_pushes_enforcement_level: "off" | "non_admins" | "everyone"; - authorized_actor_names: string[]; - authorized_actors_only: boolean; - authorized_dismissal_actors_only: boolean; - create_protected?: boolean; - /** Format: date-time */ - created_at: string; - dismiss_stale_reviews_on_push: boolean; - id: number; - ignore_approvals_from_contributors: boolean; - /** @enum {string} */ - linear_history_requirement_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - /** @enum {string} */ - merge_queue_enforcement_level: "off" | "non_admins" | "everyone"; - name: string; - /** @enum {string} */ - pull_request_reviews_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - repository_id: number; - require_code_owner_review: boolean; - /** @description Whether the most recent push must be approved by someone other than the person who pushed it */ - require_last_push_approval?: boolean; - required_approving_review_count: number; - /** @enum {string} */ - required_conversation_resolution_level: - | "off" - | "non_admins" - | "everyone"; - /** @enum {string} */ - required_deployments_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - required_status_checks: string[]; - /** @enum {string} */ - required_status_checks_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - /** @enum {string} */ - signature_requirement_enforcement_level: - | "off" - | "non_admins" - | "everyone"; - strict_required_status_checks_policy: boolean; - /** Format: date-time */ - updated_at: string; - }; + rule: components["schemas"]["webhooks_rule"]; sender: components["schemas"]["simple-user-webhooks"]; }; /** Check Run Completed Event */