From 4bba98b245552b953273dbb2a36ef6dbc6f80904 Mon Sep 17 00:00:00 2001
From: docs-bot <77750099+docs-bot@users.noreply.github.com>
Date: Fri, 21 Jun 2024 11:43:09 -0700
Subject: [PATCH] Update OpenAPI Description (#51339)

---
 src/github-apps/lib/config.json         |   2 +-
 src/rest/lib/config.json                |   2 +-
 src/webhooks/data/fpt/schema.json       | 110 ++++++++++++++++++++++++
 src/webhooks/data/ghec/schema.json      | 110 ++++++++++++++++++++++++
 src/webhooks/data/ghes-3.10/schema.json |  31 +++++++
 src/webhooks/data/ghes-3.11/schema.json |  31 +++++++
 src/webhooks/data/ghes-3.12/schema.json |  31 +++++++
 src/webhooks/data/ghes-3.13/schema.json |  31 +++++++
 src/webhooks/data/ghes-3.9/schema.json  |  18 ++++
 src/webhooks/lib/config.json            |   2 +-
 10 files changed, 365 insertions(+), 3 deletions(-)

diff --git a/src/github-apps/lib/config.json b/src/github-apps/lib/config.json
index 6cba0f1810..fd29a4024c 100644
--- a/src/github-apps/lib/config.json
+++ b/src/github-apps/lib/config.json
@@ -60,5 +60,5 @@
       "2022-11-28"
     ]
   },
-  "sha": "96c05975a63d13d4dff90a65545652eb39d0bbab"
+  "sha": "f7ddcdd2bb3905c0117ec1617f468655c087e58a"
 }
\ No newline at end of file
diff --git a/src/rest/lib/config.json b/src/rest/lib/config.json
index 42cc1aa672..bdf48adbe5 100644
--- a/src/rest/lib/config.json
+++ b/src/rest/lib/config.json
@@ -47,5 +47,5 @@
       ]
     }
   },
-  "sha": "96c05975a63d13d4dff90a65545652eb39d0bbab"
+  "sha": "f7ddcdd2bb3905c0117ec1617f468655c087e58a"
 }
\ No newline at end of file
diff --git a/src/webhooks/data/fpt/schema.json b/src/webhooks/data/fpt/schema.json
index d45f3839e1..746188f2e4 100644
--- a/src/webhooks/data/fpt/schema.json
+++ b/src/webhooks/data/fpt/schema.json
@@ -261,6 +261,22 @@
                 "everyone"
               ]
             },
+            {
+              "type": "string",
+              "name": "lock_branch_enforcement_level",
+              "description": "<p>The enforcement level of the branch lock setting. <code>off</code> means the branch is not locked, <code>non_admins</code> means the branch is read-only for non_admins, and <code>everyone</code> means the branch is read-only for everyone.</p>",
+              "isRequired": true,
+              "enum": [
+                "off",
+                "non_admins",
+                "everyone"
+              ]
+            },
+            {
+              "type": "boolean",
+              "name": "lock_allows_fork_sync",
+              "description": "<p>Whether users can pull changes from upstream when the branch is locked. Set to <code>true</code> to allow users to pull changes from upstream when the branch is locked. This setting is only applicable for forks.</p>"
+            },
             {
               "type": "string",
               "name": "merge_queue_enforcement_level",
@@ -530,6 +546,22 @@
                 "everyone"
               ]
             },
+            {
+              "type": "string",
+              "name": "lock_branch_enforcement_level",
+              "description": "<p>The enforcement level of the branch lock setting. <code>off</code> means the branch is not locked, <code>non_admins</code> means the branch is read-only for non_admins, and <code>everyone</code> means the branch is read-only for everyone.</p>",
+              "isRequired": true,
+              "enum": [
+                "off",
+                "non_admins",
+                "everyone"
+              ]
+            },
+            {
+              "type": "boolean",
+              "name": "lock_allows_fork_sync",
+              "description": "<p>Whether users can pull changes from upstream when the branch is locked. Set to <code>true</code> to allow users to pull changes from upstream when the branch is locked. This setting is only applicable for forks.</p>"
+            },
             {
               "type": "string",
               "name": "merge_queue_enforcement_level",
@@ -753,6 +785,68 @@
                 }
               ]
             },
+            {
+              "type": "object",
+              "name": "lock_branch_enforcement_level",
+              "description": "",
+              "childParamsGroups": [
+                {
+                  "type": "string",
+                  "name": "from",
+                  "description": "",
+                  "isRequired": true,
+                  "enum": [
+                    "off",
+                    "non_admins",
+                    "everyone"
+                  ]
+                }
+              ]
+            },
+            {
+              "type": "object",
+              "name": "lock_allows_fork_sync",
+              "description": "",
+              "childParamsGroups": [
+                {
+                  "type": "boolean or null",
+                  "name": "from",
+                  "description": "",
+                  "isRequired": true
+                }
+              ]
+            },
+            {
+              "type": "object",
+              "name": "pull_request_reviews_enforcement_level",
+              "description": "",
+              "childParamsGroups": [
+                {
+                  "type": "string",
+                  "name": "from",
+                  "description": "",
+                  "isRequired": true,
+                  "enum": [
+                    "off",
+                    "non_admins",
+                    "everyone"
+                  ]
+                }
+              ]
+            },
+            {
+              "type": "object",
+              "name": "require_last_push_approval",
+              "description": "",
+              "childParamsGroups": [
+                {
+                  "type": "boolean or null",
+                  "name": "from",
+                  "description": "",
+                  "isRequired": true
+                }
+              ]
+            },
             {
               "type": "object",
               "name": "required_status_checks",
@@ -908,6 +1002,22 @@
                 "everyone"
               ]
             },
+            {
+              "type": "string",
+              "name": "lock_branch_enforcement_level",
+              "description": "<p>The enforcement level of the branch lock setting. <code>off</code> means the branch is not locked, <code>non_admins</code> means the branch is read-only for non_admins, and <code>everyone</code> means the branch is read-only for everyone.</p>",
+              "isRequired": true,
+              "enum": [
+                "off",
+                "non_admins",
+                "everyone"
+              ]
+            },
+            {
+              "type": "boolean",
+              "name": "lock_allows_fork_sync",
+              "description": "<p>Whether users can pull changes from upstream when the branch is locked. Set to <code>true</code> to allow users to pull changes from upstream when the branch is locked. This setting is only applicable for forks.</p>"
+            },
             {
               "type": "string",
               "name": "merge_queue_enforcement_level",
diff --git a/src/webhooks/data/ghec/schema.json b/src/webhooks/data/ghec/schema.json
index 85c6776145..2118670dc1 100644
--- a/src/webhooks/data/ghec/schema.json
+++ b/src/webhooks/data/ghec/schema.json
@@ -261,6 +261,22 @@
                 "everyone"
               ]
             },
+            {
+              "type": "string",
+              "name": "lock_branch_enforcement_level",
+              "description": "<p>The enforcement level of the branch lock setting. <code>off</code> means the branch is not locked, <code>non_admins</code> means the branch is read-only for non_admins, and <code>everyone</code> means the branch is read-only for everyone.</p>",
+              "isRequired": true,
+              "enum": [
+                "off",
+                "non_admins",
+                "everyone"
+              ]
+            },
+            {
+              "type": "boolean",
+              "name": "lock_allows_fork_sync",
+              "description": "<p>Whether users can pull changes from upstream when the branch is locked. Set to <code>true</code> to allow users to pull changes from upstream when the branch is locked. This setting is only applicable for forks.</p>"
+            },
             {
               "type": "string",
               "name": "merge_queue_enforcement_level",
@@ -530,6 +546,22 @@
                 "everyone"
               ]
             },
+            {
+              "type": "string",
+              "name": "lock_branch_enforcement_level",
+              "description": "<p>The enforcement level of the branch lock setting. <code>off</code> means the branch is not locked, <code>non_admins</code> means the branch is read-only for non_admins, and <code>everyone</code> means the branch is read-only for everyone.</p>",
+              "isRequired": true,
+              "enum": [
+                "off",
+                "non_admins",
+                "everyone"
+              ]
+            },
+            {
+              "type": "boolean",
+              "name": "lock_allows_fork_sync",
+              "description": "<p>Whether users can pull changes from upstream when the branch is locked. Set to <code>true</code> to allow users to pull changes from upstream when the branch is locked. This setting is only applicable for forks.</p>"
+            },
             {
               "type": "string",
               "name": "merge_queue_enforcement_level",
@@ -753,6 +785,68 @@
                 }
               ]
             },
+            {
+              "type": "object",
+              "name": "lock_branch_enforcement_level",
+              "description": "",
+              "childParamsGroups": [
+                {
+                  "type": "string",
+                  "name": "from",
+                  "description": "",
+                  "isRequired": true,
+                  "enum": [
+                    "off",
+                    "non_admins",
+                    "everyone"
+                  ]
+                }
+              ]
+            },
+            {
+              "type": "object",
+              "name": "lock_allows_fork_sync",
+              "description": "",
+              "childParamsGroups": [
+                {
+                  "type": "boolean or null",
+                  "name": "from",
+                  "description": "",
+                  "isRequired": true
+                }
+              ]
+            },
+            {
+              "type": "object",
+              "name": "pull_request_reviews_enforcement_level",
+              "description": "",
+              "childParamsGroups": [
+                {
+                  "type": "string",
+                  "name": "from",
+                  "description": "",
+                  "isRequired": true,
+                  "enum": [
+                    "off",
+                    "non_admins",
+                    "everyone"
+                  ]
+                }
+              ]
+            },
+            {
+              "type": "object",
+              "name": "require_last_push_approval",
+              "description": "",
+              "childParamsGroups": [
+                {
+                  "type": "boolean or null",
+                  "name": "from",
+                  "description": "",
+                  "isRequired": true
+                }
+              ]
+            },
             {
               "type": "object",
               "name": "required_status_checks",
@@ -908,6 +1002,22 @@
                 "everyone"
               ]
             },
+            {
+              "type": "string",
+              "name": "lock_branch_enforcement_level",
+              "description": "<p>The enforcement level of the branch lock setting. <code>off</code> means the branch is not locked, <code>non_admins</code> means the branch is read-only for non_admins, and <code>everyone</code> means the branch is read-only for everyone.</p>",
+              "isRequired": true,
+              "enum": [
+                "off",
+                "non_admins",
+                "everyone"
+              ]
+            },
+            {
+              "type": "boolean",
+              "name": "lock_allows_fork_sync",
+              "description": "<p>Whether users can pull changes from upstream when the branch is locked. Set to <code>true</code> to allow users to pull changes from upstream when the branch is locked. This setting is only applicable for forks.</p>"
+            },
             {
               "type": "string",
               "name": "merge_queue_enforcement_level",
diff --git a/src/webhooks/data/ghes-3.10/schema.json b/src/webhooks/data/ghes-3.10/schema.json
index c6fe74d31b..cc2925336c 100644
--- a/src/webhooks/data/ghes-3.10/schema.json
+++ b/src/webhooks/data/ghes-3.10/schema.json
@@ -629,6 +629,37 @@
                 }
               ]
             },
+            {
+              "type": "object",
+              "name": "pull_request_reviews_enforcement_level",
+              "description": "",
+              "childParamsGroups": [
+                {
+                  "type": "string",
+                  "name": "from",
+                  "description": "",
+                  "isRequired": true,
+                  "enum": [
+                    "off",
+                    "non_admins",
+                    "everyone"
+                  ]
+                }
+              ]
+            },
+            {
+              "type": "object",
+              "name": "require_last_push_approval",
+              "description": "",
+              "childParamsGroups": [
+                {
+                  "type": "boolean or null",
+                  "name": "from",
+                  "description": "",
+                  "isRequired": true
+                }
+              ]
+            },
             {
               "type": "object",
               "name": "required_status_checks",
diff --git a/src/webhooks/data/ghes-3.11/schema.json b/src/webhooks/data/ghes-3.11/schema.json
index 6658c449f6..dfa4b9d279 100644
--- a/src/webhooks/data/ghes-3.11/schema.json
+++ b/src/webhooks/data/ghes-3.11/schema.json
@@ -753,6 +753,37 @@
                 }
               ]
             },
+            {
+              "type": "object",
+              "name": "pull_request_reviews_enforcement_level",
+              "description": "",
+              "childParamsGroups": [
+                {
+                  "type": "string",
+                  "name": "from",
+                  "description": "",
+                  "isRequired": true,
+                  "enum": [
+                    "off",
+                    "non_admins",
+                    "everyone"
+                  ]
+                }
+              ]
+            },
+            {
+              "type": "object",
+              "name": "require_last_push_approval",
+              "description": "",
+              "childParamsGroups": [
+                {
+                  "type": "boolean or null",
+                  "name": "from",
+                  "description": "",
+                  "isRequired": true
+                }
+              ]
+            },
             {
               "type": "object",
               "name": "required_status_checks",
diff --git a/src/webhooks/data/ghes-3.12/schema.json b/src/webhooks/data/ghes-3.12/schema.json
index f9ea0758a6..19f2ea0f5a 100644
--- a/src/webhooks/data/ghes-3.12/schema.json
+++ b/src/webhooks/data/ghes-3.12/schema.json
@@ -753,6 +753,37 @@
                 }
               ]
             },
+            {
+              "type": "object",
+              "name": "pull_request_reviews_enforcement_level",
+              "description": "",
+              "childParamsGroups": [
+                {
+                  "type": "string",
+                  "name": "from",
+                  "description": "",
+                  "isRequired": true,
+                  "enum": [
+                    "off",
+                    "non_admins",
+                    "everyone"
+                  ]
+                }
+              ]
+            },
+            {
+              "type": "object",
+              "name": "require_last_push_approval",
+              "description": "",
+              "childParamsGroups": [
+                {
+                  "type": "boolean or null",
+                  "name": "from",
+                  "description": "",
+                  "isRequired": true
+                }
+              ]
+            },
             {
               "type": "object",
               "name": "required_status_checks",
diff --git a/src/webhooks/data/ghes-3.13/schema.json b/src/webhooks/data/ghes-3.13/schema.json
index 3315c2ea43..45e7c8c470 100644
--- a/src/webhooks/data/ghes-3.13/schema.json
+++ b/src/webhooks/data/ghes-3.13/schema.json
@@ -753,6 +753,37 @@
                 }
               ]
             },
+            {
+              "type": "object",
+              "name": "pull_request_reviews_enforcement_level",
+              "description": "",
+              "childParamsGroups": [
+                {
+                  "type": "string",
+                  "name": "from",
+                  "description": "",
+                  "isRequired": true,
+                  "enum": [
+                    "off",
+                    "non_admins",
+                    "everyone"
+                  ]
+                }
+              ]
+            },
+            {
+              "type": "object",
+              "name": "require_last_push_approval",
+              "description": "",
+              "childParamsGroups": [
+                {
+                  "type": "boolean or null",
+                  "name": "from",
+                  "description": "",
+                  "isRequired": true
+                }
+              ]
+            },
             {
               "type": "object",
               "name": "required_status_checks",
diff --git a/src/webhooks/data/ghes-3.9/schema.json b/src/webhooks/data/ghes-3.9/schema.json
index f4b87398f7..1914e46c22 100644
--- a/src/webhooks/data/ghes-3.9/schema.json
+++ b/src/webhooks/data/ghes-3.9/schema.json
@@ -619,6 +619,24 @@
                 }
               ]
             },
+            {
+              "type": "object",
+              "name": "pull_request_reviews_enforcement_level",
+              "description": "",
+              "childParamsGroups": [
+                {
+                  "type": "string",
+                  "name": "from",
+                  "description": "",
+                  "isRequired": true,
+                  "enum": [
+                    "off",
+                    "non_admins",
+                    "everyone"
+                  ]
+                }
+              ]
+            },
             {
               "type": "object",
               "name": "required_status_checks",
diff --git a/src/webhooks/lib/config.json b/src/webhooks/lib/config.json
index 290cfc8fe1..70ed9ea5b1 100644
--- a/src/webhooks/lib/config.json
+++ b/src/webhooks/lib/config.json
@@ -1,3 +1,3 @@
 {
-  "sha": "96c05975a63d13d4dff90a65545652eb39d0bbab"
+  "sha": "f7ddcdd2bb3905c0117ec1617f468655c087e58a"
 }
\ No newline at end of file