WIP

octokit · Apr 22, 2024 · 99a9ecf · 99a9ecf
1 parent 8cd7820
commit 99a9ecf
Show file tree

Hide file tree

Showing 20 changed files with 2,016 additions and 4,320 deletions.
diff --git a/cache/api.github.com.json b/cache/api.github.com.json
diff --git a/cache/ghec.json b/cache/ghec.json
diff --git a/cache/ghes-3.10.json b/cache/ghes-3.10.json
diff --git a/cache/ghes-3.11.json b/cache/ghes-3.11.json
diff --git a/cache/ghes-3.12.json b/cache/ghes-3.12.json
diff --git a/cache/ghes-3.9.json b/cache/ghes-3.9.json
diff --git 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
@@ -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
@@ -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
@@ -16,6 +16,6 @@
  "author": "Gregor Martynus (https://twitter.com/gr2m)",
  "license": "MIT",
  "octokit": {
- "openapi-version": "16.2.0"
+ "openapi-version": "16.3.0"
  }
 }