Update OpenAPI Description (#52323)

Co-authored-by: Siara <108543037+SiaraMist@users.noreply.github.com>
github · Sep 17, 2024 · f5ed722 · f5ed722
1 parent d92a8dc
commit f5ed722
Show file tree

Hide file tree

Showing 8 changed files with 123 additions and 51 deletions.
diff --git a/src/github-apps/lib/config.json b/src/github-apps/lib/config.json
@@ -60,5 +60,5 @@
       "2022-11-28"
     ]
   },
-  "sha": "066dbf5dc65b77a59b36a517cafeda2feb369334"
+  "sha": "5a9222e9dba71d8c7d75d8e780cf091f16a9f5a7"
 }
diff --git a/src/rest/data/fpt-2022-11-28/schema.json b/src/rest/data/fpt-2022-11-28/schema.json
@@ -362106,7 +362106,8 @@
                       "type": "string",
                       "enum": [
                         "pass",
-                        "fail"
+                        "fail",
+                        "bypass"
                       ],
                       "description": "The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`."
                     }
@@ -362290,12 +362291,17 @@
                     "description": "The result of the rule evaluations for rules with the `active` enforcement status."
                   },
                   "evaluation_result": {
-                    "type": "string",
+                    "type": [
+                      "string",
+                      "null"
+                    ],
                     "enum": [
                       "pass",
-                      "fail"
+                      "fail",
+                      "bypass",
+                      null
                     ],
-                    "description": "The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`."
+                    "description": "The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. Null if no rules with `evaluate` enforcement status were run."
                   },
                   "rule_evaluations": {
                     "type": "array",
@@ -362348,8 +362354,11 @@
                           "description": "The type of rule."
                         },
                         "details": {
-                          "type": "string",
-                          "description": "Any associated details with the rule evaluation."
+                          "type": [
+                            "string",
+                            "null"
+                          ],
+                          "description": "The detailed failure message for the rule. Null if the rule passed."
                         }
                       }
                     }
@@ -489242,7 +489251,8 @@
                       "type": "string",
                       "enum": [
                         "pass",
-                        "fail"
+                        "fail",
+                        "bypass"
                       ],
                       "description": "The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`."
                     }
@@ -489436,12 +489446,17 @@
                     "description": "The result of the rule evaluations for rules with the `active` enforcement status."
                   },
                   "evaluation_result": {
-                    "type": "string",
+                    "type": [
+                      "string",
+                      "null"
+                    ],
                     "enum": [
                       "pass",
-                      "fail"
+                      "fail",
+                      "bypass",
+                      null
                     ],
-                    "description": "The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`."
+                    "description": "The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. Null if no rules with `evaluate` enforcement status were run."
                   },
                   "rule_evaluations": {
                     "type": "array",
@@ -489494,8 +489509,11 @@
                           "description": "The type of rule."
                         },
                         "details": {
-                          "type": "string",
-                          "description": "Any associated details with the rule evaluation."
+                          "type": [
+                            "string",
+                            "null"
+                          ],
+                          "description": "The detailed failure message for the rule. Null if the rule passed."
                         }
                       }
                     }

diff --git a/src/rest/data/ghec-2022-11-28/schema.json b/src/rest/data/ghec-2022-11-28/schema.json
@@ -386345,7 +386345,8 @@
                       "type": "string",
                       "enum": [
                         "pass",
-                        "fail"
+                        "fail",
+                        "bypass"
                       ],
                       "description": "The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`."
                     }
@@ -386529,12 +386530,17 @@
                     "description": "The result of the rule evaluations for rules with the `active` enforcement status."
                   },
                   "evaluation_result": {
-                    "type": "string",
+                    "type": [
+                      "string",
+                      "null"
+                    ],
                     "enum": [
                       "pass",
-                      "fail"
+                      "fail",
+                      "bypass",
+                      null
                     ],
-                    "description": "The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`."
+                    "description": "The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. Null if no rules with `evaluate` enforcement status were run."
                   },
                   "rule_evaluations": {
                     "type": "array",
@@ -386587,8 +386593,11 @@
                           "description": "The type of rule."
                         },
                         "details": {
-                          "type": "string",
-                          "description": "Any associated details with the rule evaluation."
+                          "type": [
+                            "string",
+                            "null"
+                          ],
+                          "description": "The detailed failure message for the rule. Null if the rule passed."
                         }
                       }
                     }
@@ -513876,7 +513885,8 @@
                       "type": "string",
                       "enum": [
                         "pass",
-                        "fail"
+                        "fail",
+                        "bypass"
                       ],
                       "description": "The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`."
                     }
@@ -514070,12 +514080,17 @@
                     "description": "The result of the rule evaluations for rules with the `active` enforcement status."
                   },
                   "evaluation_result": {
-                    "type": "string",
+                    "type": [
+                      "string",
+                      "null"
+                    ],
                     "enum": [
                       "pass",
-                      "fail"
+                      "fail",
+                      "bypass",
+                      null
                     ],
-                    "description": "The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`."
+                    "description": "The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. Null if no rules with `evaluate` enforcement status were run."
                   },
                   "rule_evaluations": {
                     "type": "array",
@@ -514128,8 +514143,11 @@
                           "description": "The type of rule."
                         },
                         "details": {
-                          "type": "string",
-                          "description": "Any associated details with the rule evaluation."
+                          "type": [
+                            "string",
+                            "null"
+                          ],
+                          "description": "The detailed failure message for the rule. Null if the rule passed."
                         }
                       }
                     }

diff --git a/src/rest/data/ghes-3.12-2022-11-28/schema.json b/src/rest/data/ghes-3.12-2022-11-28/schema.json
@@ -331497,12 +331497,15 @@
                     "description": "The result of the rule evaluations for rules with the `active` enforcement status."
                   },
                   "evaluation_result": {
-                    "type": "string",
+                    "type": [
+                      "string",
+                      "null"
+                    ],
                     "enum": [
                       "pass",
                       "fail"
                     ],
-                    "description": "The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`."
+                    "description": "The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. Null if no rules with `evaluate` enforcement status were run."
                   },
                   "rule_evaluations": {
                     "type": "array",
@@ -331555,8 +331558,11 @@
                           "description": "The type of rule."
                         },
                         "details": {
-                          "type": "string",
-                          "description": "Any associated details with the rule evaluation."
+                          "type": [
+                            "string",
+                            "null"
+                          ],
+                          "description": "The detailed failure message for the rule. Null if the rule passed."
                         }
                       }
                     }
@@ -454674,12 +454680,15 @@
                     "description": "The result of the rule evaluations for rules with the `active` enforcement status."
                   },
                   "evaluation_result": {
-                    "type": "string",
+                    "type": [
+                      "string",
+                      "null"
+                    ],
                     "enum": [
                       "pass",
                       "fail"
                     ],
-                    "description": "The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`."
+                    "description": "The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. Null if no rules with `evaluate` enforcement status were run."
                   },
                   "rule_evaluations": {
                     "type": "array",
@@ -454732,8 +454741,11 @@
                           "description": "The type of rule."
                         },
                         "details": {
-                          "type": "string",
-                          "description": "Any associated details with the rule evaluation."
+                          "type": [
+                            "string",
+                            "null"
+                          ],
+                          "description": "The detailed failure message for the rule. Null if the rule passed."
                         }
                       }
                     }

diff --git a/src/rest/data/ghes-3.13-2022-11-28/schema.json b/src/rest/data/ghes-3.13-2022-11-28/schema.json
@@ -333004,12 +333004,15 @@
                     "description": "The result of the rule evaluations for rules with the `active` enforcement status."
                   },
                   "evaluation_result": {
-                    "type": "string",
+                    "type": [
+                      "string",
+                      "null"
+                    ],
                     "enum": [
                       "pass",
                       "fail"
                     ],
-                    "description": "The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`."
+                    "description": "The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. Null if no rules with `evaluate` enforcement status were run."
                   },
                   "rule_evaluations": {
                     "type": "array",
@@ -333062,8 +333065,11 @@
                           "description": "The type of rule."
                         },
                         "details": {
-                          "type": "string",
-                          "description": "Any associated details with the rule evaluation."
+                          "type": [
+                            "string",
+                            "null"
+                          ],
+                          "description": "The detailed failure message for the rule. Null if the rule passed."
                         }
                       }
                     }
@@ -457286,12 +457292,15 @@
                     "description": "The result of the rule evaluations for rules with the `active` enforcement status."
                   },
                   "evaluation_result": {
-                    "type": "string",
+                    "type": [
+                      "string",
+                      "null"
+                    ],
                     "enum": [
                       "pass",
                       "fail"
                     ],
-                    "description": "The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`."
+                    "description": "The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. Null if no rules with `evaluate` enforcement status were run."
                   },
                   "rule_evaluations": {
                     "type": "array",
@@ -457344,8 +457353,11 @@
                           "description": "The type of rule."
                         },
                         "details": {
-                          "type": "string",
-                          "description": "Any associated details with the rule evaluation."
+                          "type": [
+                            "string",
+                            "null"
+                          ],
+                          "description": "The detailed failure message for the rule. Null if the rule passed."
                         }
                       }
                     }

diff --git a/src/rest/data/ghes-3.14-2022-11-28/schema.json b/src/rest/data/ghes-3.14-2022-11-28/schema.json
@@ -335580,12 +335580,15 @@
                     "description": "The result of the rule evaluations for rules with the `active` enforcement status."
                   },
                   "evaluation_result": {
-                    "type": "string",
+                    "type": [
+                      "string",
+                      "null"
+                    ],
                     "enum": [
                       "pass",
                       "fail"
                     ],
-                    "description": "The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`."
+                    "description": "The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. Null if no rules with `evaluate` enforcement status were run."
                   },
                   "rule_evaluations": {
                     "type": "array",
@@ -335638,8 +335641,11 @@
                           "description": "The type of rule."
                         },
                         "details": {
-                          "type": "string",
-                          "description": "Any associated details with the rule evaluation."
+                          "type": [
+                            "string",
+                            "null"
+                          ],
+                          "description": "The detailed failure message for the rule. Null if the rule passed."
                         }
                       }
                     }
@@ -460260,12 +460266,15 @@
                     "description": "The result of the rule evaluations for rules with the `active` enforcement status."
                   },
                   "evaluation_result": {
-                    "type": "string",
+                    "type": [
+                      "string",
+                      "null"
+                    ],
                     "enum": [
                       "pass",
                       "fail"
                     ],
-                    "description": "The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`."
+                    "description": "The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. Null if no rules with `evaluate` enforcement status were run."
                   },
                   "rule_evaluations": {
                     "type": "array",
@@ -460318,8 +460327,11 @@
                           "description": "The type of rule."
                         },
                         "details": {
-                          "type": "string",
-                          "description": "Any associated details with the rule evaluation."
+                          "type": [
+                            "string",
+                            "null"
+                          ],
+                          "description": "The detailed failure message for the rule. Null if the rule passed."
                         }
                       }
                     }

diff --git a/src/rest/lib/config.json b/src/rest/lib/config.json
@@ -47,5 +47,5 @@
       ]
     }
   },
-  "sha": "066dbf5dc65b77a59b36a517cafeda2feb369334"
+  "sha": "5a9222e9dba71d8c7d75d8e780cf091f16a9f5a7"
 }
diff --git a/src/webhooks/lib/config.json b/src/webhooks/lib/config.json
@@ -1,3 +1,3 @@
 {
-  "sha": "066dbf5dc65b77a59b36a517cafeda2feb369334"
+  "sha": "5a9222e9dba71d8c7d75d8e780cf091f16a9f5a7"
 }