Update OpenAPI 3.0 Descriptions

github · Sep 5, 2023 · 9e0fabf · 9e0fabf
1 parent 77e3de6
commit 9e0fabf
Show file tree

Hide file tree

Showing 16 changed files with 40 additions and 32 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
@@ -46320,7 +46320,7 @@
     "/repos/{owner}/{repo}/rules/branches/{branch}": {
       "get": {
         "summary": "Get rules for a branch",
-        "description": "Returns all rules that apply to the specified branch. The branch does not need to exist; rules that would apply to a\nbranch with that name will be returned. All rules that apply will be returned, regardless of the level at which they\nare configured.",
+        "description": "Returns all active rules that apply to the specified branch. The branch does not need to exist; rules that would apply\nto a branch with that name will be returned. All active rules that apply will be returned, regardless of the level\nat which they are configured (e.g. repository or organization). Rules in rulesets with \"evaluate\" or \"disabled\"\nenforcement statuses are not returned.",
         "tags": [
           "repos"
         ],

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
@@ -33084,9 +33084,10 @@ paths:
     get:
       summary: Get rules for a branch
       description: |-
-        Returns all rules that apply to the specified branch. The branch does not need to exist; rules that would apply to a
-        branch with that name will be returned. All rules that apply will be returned, regardless of the level at which they
-        are configured.
+        Returns all active rules that apply to the specified branch. The branch does not need to exist; rules that would apply
+        to a branch with that name will be returned. All active rules that apply will be returned, regardless of the level
+        at which they are configured (e.g. repository or organization). Rules in rulesets with "evaluate" or "disabled"
+        enforcement statuses are not returned.
       tags:
       - repos
       operationId: repos/get-branch-rules

diff --git a/descriptions/api.github.com/api.github.com.json b/descriptions/api.github.com/api.github.com.json
@@ -46320,7 +46320,7 @@
     "/repos/{owner}/{repo}/rules/branches/{branch}": {
       "get": {
         "summary": "Get rules for a branch",
-        "description": "Returns all rules that apply to the specified branch. The branch does not need to exist; rules that would apply to a\nbranch with that name will be returned. All rules that apply will be returned, regardless of the level at which they\nare configured.",
+        "description": "Returns all active rules that apply to the specified branch. The branch does not need to exist; rules that would apply\nto a branch with that name will be returned. All active rules that apply will be returned, regardless of the level\nat which they are configured (e.g. repository or organization). Rules in rulesets with \"evaluate\" or \"disabled\"\nenforcement statuses are not returned.",
         "tags": [
           "repos"
         ],