Update OpenAPI 3.0 Descriptions

github · Apr 5, 2024 · 4d63920 · 4d63920
1 parent 28c94f8
commit 4d63920
Show file tree

Hide file tree

Showing 28 changed files with 674 additions and 104 deletions.
diff --git a/descriptions/api.github.com/api.github.com.2022-11-28.json b/descriptions/api.github.com/api.github.com.2022-11-28.json
@@ -15223,7 +15223,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"
                   },
@@ -96265,7 +96275,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"
           },
@@ -98292,7 +98312,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",
@@ -98302,7 +98322,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/descriptions/api.github.com/api.github.com.2022-11-28.yaml b/descriptions/api.github.com/api.github.com.2022-11-28.yaml
@@ -11052,7 +11052,11 @@ paths:
                   type: boolean
                   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
                 description:
@@ -70076,7 +70080,11 @@ components:
           type: boolean
           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
         description:
@@ -71685,17 +71693,19 @@ components:
       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
           - errors_and_warnings
           - all
         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/descriptions/api.github.com/api.github.com.json b/descriptions/api.github.com/api.github.com.json
@@ -15223,7 +15223,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"
                   },
@@ -96265,7 +96275,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"
           },
@@ -98292,7 +98312,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",
@@ -98302,7 +98322,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/descriptions/api.github.com/api.github.com.yaml b/descriptions/api.github.com/api.github.com.yaml
@@ -11052,7 +11052,11 @@ paths:
                   type: boolean
                   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
                 description:
@@ -70076,7 +70080,11 @@ components:
           type: boolean
           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
         description:
@@ -71685,17 +71693,19 @@ components:
       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
           - errors_and_warnings
           - all
         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