fix: description updates, new parameter for `enterprise-admin/license…

…-upload`, `default_value` field can now also be `string[]` on custom_property (#411) WIP
octokit · Apr 9, 2024 · cf05067 · cf05067
1 parent 4b9cfb3
commit cf05067
Show file tree

Hide file tree

Showing 18 changed files with 99 additions and 38 deletions.
diff --git a/cache/api.github.com.json b/cache/api.github.com.json
@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "version": "16.0.0",
+    "version": "16.1.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": {
@@ -16177,7 +16177,17 @@
                     "description": "Whether the property is required."
                   },
                   "default_value": {
-                    "type": "string",
+                    "oneOf": [
+                      {
+                        "type": "string"
+                      },
+                      {
+                        "type": "array",
+                        "items": {
+                          "type": "string"
+                        }
+                      }
+                    ],
                     "nullable": true,
                     "description": "Default value of the property"
                   },
@@ -98011,7 +98021,17 @@
             "description": "Whether the property is required."
           },
           "default_value": {
-            "type": "string",
+            "oneOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                }
+              }
+            ],
             "nullable": true,
             "description": "Default value of the property"
           },
@@ -100038,7 +100058,7 @@
         "properties": {
           "alerts_threshold": {
             "type": "string",
-            "description": "The threshold at which code scanning results that introduce alerts block a ref update.",
+            "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",
@@ -100048,7 +100068,7 @@
           },
           "security_alerts_threshold": {
             "type": "string",
-            "description": "The threshold at which code scanning results that introduce security alerts block a ref update.",
+            "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",

diff --git a/cache/ghec.json b/cache/ghec.json
@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "version": "16.0.0",
+    "version": "16.1.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": {
@@ -20814,7 +20814,17 @@
                     "description": "Whether the property is required."
                   },
                   "default_value": {
-                    "type": "string",
+                    "oneOf": [
+                      {
+                        "type": "string"
+                      },
+                      {
+                        "type": "array",
+                        "items": {
+                          "type": "string"
+                        }
+                      }
+                    ],
                     "nullable": true,
                     "description": "Default value of the property"
                   },
@@ -106553,7 +106563,17 @@
             "description": "Whether the property is required."
           },
           "default_value": {
-            "type": "string",
+            "oneOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                }
+              }
+            ],
             "nullable": true,
             "description": "Default value of the property"
           },
@@ -108580,7 +108600,7 @@
         "properties": {
           "alerts_threshold": {
             "type": "string",
-            "description": "The threshold at which code scanning results that introduce alerts block a ref update.",
+            "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",
@@ -108590,7 +108610,7 @@
           },
           "security_alerts_threshold": {
             "type": "string",
-            "description": "The threshold at which code scanning results that introduce security alerts block a ref update.",
+            "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",

diff --git a/cache/ghes-3.10.json b/cache/ghes-3.10.json
@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "version": "16.0.0",
+    "version": "16.1.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/cache/ghes-3.11.json b/cache/ghes-3.11.json
@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "version": "16.0.0",
+    "version": "16.1.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": {
@@ -102168,7 +102168,7 @@
         "properties": {
           "alerts_threshold": {
             "type": "string",
-            "description": "The threshold at which code scanning results that introduce alerts block a ref update.",
+            "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/[email protected]/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"",
             "enum": [
               "none",
               "errors",
@@ -102178,7 +102178,7 @@
           },
           "security_alerts_threshold": {
             "type": "string",
-            "description": "The threshold at which code scanning results that introduce security alerts block a ref update.",
+            "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/[email protected]/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"",
             "enum": [
               "none",
               "critical",

diff --git a/cache/ghes-3.12.json b/cache/ghes-3.12.json
@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "version": "16.0.0",
+    "version": "16.1.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": {
@@ -10946,6 +10946,11 @@
             }
           }
         ],
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/license-apply"
+          }
+        ],
         "requestBody": {
           "required": true,
           "content": {
@@ -104099,7 +104104,7 @@
         "properties": {
           "alerts_threshold": {
             "type": "string",
-            "description": "The threshold at which code scanning results that introduce alerts block a ref update.",
+            "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/[email protected]/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"",
             "enum": [
               "none",
               "errors",
@@ -104109,7 +104114,7 @@
           },
           "security_alerts_threshold": {
             "type": "string",
-            "description": "The threshold at which code scanning results that introduce security alerts block a ref update.",
+            "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/[email protected]/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"",
             "enum": [
               "none",
               "critical",
@@ -301849,6 +301854,15 @@
           "type": "string"
         }
       },
+      "license-apply": {
+        "name": "apply",
+        "description": "Whether to apply changes from the license. Uploading a license does not automatically apply changes. To make the changes effective, you can specify to apply the license too.",
+        "in": "query",
+        "required": false,
+        "schema": {
+          "type": "boolean"
+        }
+      },
       "uuid": {
         "name": "uuid",
         "description": "The UUID which identifies a node.",

diff --git a/cache/ghes-3.9.json b/cache/ghes-3.9.json
@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "version": "16.0.0",
+    "version": "16.1.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/cache/github.ae.json b/cache/github.ae.json
@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "version": "16.0.0",
+    "version": "16.1.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.0.0"
+    "openapi-version": "16.1.0"
   }
 }
diff --git a/packages/openapi-types-ghec/types.d.ts b/packages/openapi-types-ghec/types.d.ts
@@ -16615,7 +16615,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;
       /** @description Short description of the property */
       description?: string | null;
       /**
@@ -17691,12 +17691,12 @@ export interface components {
      */
     "repository-rule-params-code-scanning-tool": {
       /**
-       * @description The threshold at which code scanning results that introduce alerts block a ref update.
+       * @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 {string}
        */
       alerts_threshold: "none" | "errors" | "errors_and_warnings" | "all";
       /**
-       * @description The threshold at which code scanning results that introduce security alerts block a ref update.
+       * @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 {string}
        */
       security_alerts_threshold:
@@ -100565,7 +100565,7 @@ export interface operations {
           /** @description Whether the property is required. */
           required?: boolean;
           /** @description Default value of the property */
-          default_value?: string | null;
+          default_value?: string | string[] | null;
           /** @description Short description of the property */
           description?: string | null;
           /**

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.0.0"
+    "openapi-version": "16.1.0"
   }
 }