feat: renames [repository-rule-params-code-scanning-threshold to repo…

…sitory-rule-params-code-scanning-tool, security_alerts to security_alerts_threshold], renames fields[repository-rule-params-code-scanning-threshold.alerts to repository-rule-params-code-scanning-tool.alerts_threshold, repository-rule-params-code-scanning-threshold.security_alerts to repository-rule-params-code-scanning-tool.security_alerts_threshold] BREAKING CHANGE: renames [repository-rule-params-code-scanning-threshold to repository-rule-params-code-scanning-tool, security_alerts to security_alerts_threshold], renames fields[repository-rule-params-code-scanning-threshold.alerts to repository-rule-params-code-scanning-tool.alerts_threshold, repository-rule-params-code-scanning-threshold.security_alerts to repository-rule-params-code-scanning-tool.security_alerts_threshold]
octokit · Apr 5, 2024 · 5f19af4 · 5f19af4
2 parents 53ad975 + c9fb96d
commit 5f19af4
Show file tree

Hide file tree

Showing 8 changed files with 58 additions and 42 deletions.
diff --git a/cache/api.github.com.json b/cache/api.github.com.json
@@ -26012,8 +26012,12 @@
             "description": "Whether the property is required."
           },
           "default_value": {
-            "type": ["string", "null"],
-            "description": "Default value of the property"
+            "oneOf": [
+              { "type": "string" },
+              { "type": "array", "items": { "type": "string" } }
+            ],
+            "description": "Default value of the property",
+            "type": ["null", "string", "array"]
           },
           "description": {
             "type": ["string", "null"],
@@ -27181,19 +27185,19 @@
           }
         }
       },
-      "repository-rule-params-code-scanning-threshold": {
-        "title": "CodeScanningThreshold",
-        "description": "A tool and its thresholds.",
+      "repository-rule-params-code-scanning-tool": {
+        "title": "CodeScanningTool",
+        "description": "A tool that must provide code scanning results for this rule to pass.",
         "type": "object",
         "properties": {
-          "alerts": {
+          "alerts_threshold": {
             "type": "string",
-            "description": "Code scanning alert threshold",
+            "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"",
             "enum": ["none", "errors", "errors_and_warnings", "all"]
           },
-          "security_alerts": {
+          "security_alerts_threshold": {
             "type": "string",
-            "description": "Code scanning security alert threshold.",
+            "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"",
             "enum": [
               "none",
               "critical",
@@ -27207,7 +27211,7 @@
             "description": "The name of a code scanning tool"
           }
         },
-        "required": ["alerts", "security_alerts", "tool"]
+        "required": ["alerts_threshold", "security_alerts_threshold", "tool"]
       },
       "repository-rule": {
         "title": "Repository Rule",

diff --git a/cache/ghec.json b/cache/ghec.json
@@ -27140,8 +27140,12 @@
             "description": "Whether the property is required."
           },
           "default_value": {
-            "type": ["string", "null"],
-            "description": "Default value of the property"
+            "oneOf": [
+              { "type": "string" },
+              { "type": "array", "items": { "type": "string" } }
+            ],
+            "description": "Default value of the property",
+            "type": ["null", "string", "array"]
           },
           "description": {
             "type": ["string", "null"],
@@ -28309,19 +28313,19 @@
           }
         }
       },
-      "repository-rule-params-code-scanning-threshold": {
-        "title": "CodeScanningThreshold",
-        "description": "A tool and its thresholds.",
+      "repository-rule-params-code-scanning-tool": {
+        "title": "CodeScanningTool",
+        "description": "A tool that must provide code scanning results for this rule to pass.",
         "type": "object",
         "properties": {
-          "alerts": {
+          "alerts_threshold": {
             "type": "string",
-            "description": "Code scanning alert threshold",
+            "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"",
             "enum": ["none", "errors", "errors_and_warnings", "all"]
           },
-          "security_alerts": {
+          "security_alerts_threshold": {
             "type": "string",
-            "description": "Code scanning security alert threshold.",
+            "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"",
             "enum": [
               "none",
               "critical",
@@ -28335,7 +28339,7 @@
             "description": "The name of a code scanning tool"
           }
         },
-        "required": ["alerts", "security_alerts", "tool"]
+        "required": ["alerts_threshold", "security_alerts_threshold", "tool"]
       },
       "repository-rule": {
         "title": "Repository Rule",

diff --git a/cache/ghes-3.11.json b/cache/ghes-3.11.json
@@ -28473,19 +28473,19 @@
           }
         }
       },
-      "repository-rule-params-code-scanning-threshold": {
-        "title": "CodeScanningThreshold",
-        "description": "A tool and its thresholds.",
+      "repository-rule-params-code-scanning-tool": {
+        "title": "CodeScanningTool",
+        "description": "A tool that must provide code scanning results for this rule to pass.",
         "type": "object",
         "properties": {
-          "alerts": {
+          "alerts_threshold": {
             "type": "string",
-            "description": "Code scanning alert threshold",
+            "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-server@3.11/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"",
             "enum": ["none", "errors", "errors_and_warnings", "all"]
           },
-          "security_alerts": {
+          "security_alerts_threshold": {
             "type": "string",
-            "description": "Code scanning security alert threshold.",
+            "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-server@3.11/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"",
             "enum": [
               "none",
               "critical",
@@ -28499,7 +28499,7 @@
             "description": "The name of a code scanning tool"
           }
         },
-        "required": ["alerts", "security_alerts", "tool"]
+        "required": ["alerts_threshold", "security_alerts_threshold", "tool"]
       },
       "repository-rule": {
         "title": "Repository Rule",

diff --git a/cache/ghes-3.12.json b/cache/ghes-3.12.json
@@ -29123,19 +29123,19 @@
           }
         }
       },
-      "repository-rule-params-code-scanning-threshold": {
-        "title": "CodeScanningThreshold",
-        "description": "A tool and its thresholds.",
+      "repository-rule-params-code-scanning-tool": {
+        "title": "CodeScanningTool",
+        "description": "A tool that must provide code scanning results for this rule to pass.",
         "type": "object",
         "properties": {
-          "alerts": {
+          "alerts_threshold": {
             "type": "string",
-            "description": "Code scanning alert threshold",
+            "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-server@3.12/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"",
             "enum": ["none", "errors", "errors_and_warnings", "all"]
           },
-          "security_alerts": {
+          "security_alerts_threshold": {
             "type": "string",
-            "description": "Code scanning security alert threshold.",
+            "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-server@3.12/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"",
             "enum": [
               "none",
               "critical",
@@ -29149,7 +29149,7 @@
             "description": "The name of a code scanning tool"
           }
         },
-        "required": ["alerts", "security_alerts", "tool"]
+        "required": ["alerts_threshold", "security_alerts_threshold", "tool"]
       },
       "repository-rule": {
         "title": "Repository Rule",

diff --git a/packages/openapi-webhooks-types-ghec/types.d.ts b/packages/openapi-webhooks-types-ghec/types.d.ts
@@ -5593,7 +5593,7 @@ export interface components {
       /** @description Whether the property is required. */
       required?: boolean;
       /** @description Default value of the property */
-      default_value?: string | null;
+      default_value?: string | string[] | null | unknown[];
       /** @description Short description of the property */
       description?: string | null;
       /**

diff --git a/packages/openapi-webhooks-types/types.d.ts b/packages/openapi-webhooks-types/types.d.ts
@@ -5542,7 +5542,7 @@ export interface components {
       /** @description Whether the property is required. */
       required?: boolean;
       /** @description Default value of the property */
-      default_value?: string | null;
+      default_value?: string | string[] | null | unknown[];
       /** @description Short description of the property */
       description?: string | null;
       /**

diff --git a/packages/openapi-webhooks/generated/api.github.com.json b/packages/openapi-webhooks/generated/api.github.com.json
@@ -25404,8 +25404,12 @@
             "description": "Whether the property is required."
           },
           "default_value": {
-            "type": ["string", "null"],
-            "description": "Default value of the property"
+            "oneOf": [
+              { "type": "string" },
+              { "type": "array", "items": { "type": "string" } }
+            ],
+            "description": "Default value of the property",
+            "type": ["null", "string", "array"]
           },
           "description": {
             "type": ["string", "null"],

diff --git a/packages/openapi-webhooks/generated/ghec.json b/packages/openapi-webhooks/generated/ghec.json
@@ -25494,8 +25494,12 @@
             "description": "Whether the property is required."
           },
           "default_value": {
-            "type": ["string", "null"],
-            "description": "Default value of the property"
+            "oneOf": [
+              { "type": "string" },
+              { "type": "array", "items": { "type": "string" } }
+            ],
+            "description": "Default value of the property",
+            "type": ["null", "string", "array"]
           },
           "description": {
             "type": ["string", "null"],