Update OpenAPI 3.1 Descriptions

github · Oct 9, 2023 · 30aa716 · 30aa716
1 parent 31e3181
commit 30aa716
Show file tree

Hide file tree

Showing 16 changed files with 112 additions and 100 deletions.
diff --git a/descriptions-next/api.github.com/api.github.com.2022-11-28.json b/descriptions-next/api.github.com/api.github.com.2022-11-28.json
@@ -95723,7 +95723,7 @@
         "properties": {
           "actor_id": {
             "type": "integer",
-            "description": "The ID of the actor that can bypass a ruleset"
+            "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`."
           },
           "actor_type": {
             "type": "string",
@@ -104262,7 +104262,7 @@
               "string",
               "null"
             ],
-            "description": "The commit SHA of the CodeQL databases repository at time of database creation."
+            "description": "The commit SHA of the repository at the time the CodeQL database was created."
           }
         },
         "required": [

diff --git a/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml b/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml
@@ -68527,7 +68527,8 @@ components:
       properties:
         actor_id:
           type: integer
-          description: The ID of the actor that can bypass a ruleset
+          description: The ID of the actor that can bypass a ruleset. If `actor_type`
+            is `OrganizationAdmin`, this should be `1`.
         actor_type:
           type: string
           enum:
@@ -74670,8 +74671,8 @@ components:
           type:
           - string
           - 'null'
-          description: The commit SHA of the CodeQL databases repository at time of
-            database creation.
+          description: The commit SHA of the repository at the time the CodeQL database
+            was created.
       required:
       - id
       - name

diff --git a/descriptions-next/api.github.com/api.github.com.json b/descriptions-next/api.github.com/api.github.com.json
@@ -95723,7 +95723,7 @@
         "properties": {
           "actor_id": {
             "type": "integer",
-            "description": "The ID of the actor that can bypass a ruleset"
+            "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`."
           },
           "actor_type": {
             "type": "string",
@@ -104262,7 +104262,7 @@
               "string",
               "null"
             ],
-            "description": "The commit SHA of the CodeQL databases repository at time of database creation."
+            "description": "The commit SHA of the repository at the time the CodeQL database was created."
           }
         },
         "required": [

diff --git a/descriptions-next/api.github.com/api.github.com.yaml b/descriptions-next/api.github.com/api.github.com.yaml
@@ -68527,7 +68527,8 @@ components:
       properties:
         actor_id:
           type: integer
-          description: The ID of the actor that can bypass a ruleset
+          description: The ID of the actor that can bypass a ruleset. If `actor_type`
+            is `OrganizationAdmin`, this should be `1`.
         actor_type:
           type: string
           enum:
@@ -74670,8 +74671,8 @@ components:
           type:
           - string
           - 'null'
-          description: The commit SHA of the CodeQL databases repository at time of
-            database creation.
+          description: The commit SHA of the repository at the time the CodeQL database
+            was created.
       required:
       - id
       - name