Update OpenAPI 3.0 Descriptions

github · Oct 9, 2023 · b6ea83e · b6ea83e
1 parent 3f51dc0
commit b6ea83e
Show file tree

Hide file tree

Showing 16 changed files with 112 additions and 100 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
@@ -94252,7 +94252,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",
@@ -102431,7 +102431,7 @@
           },
           "commit_oid": {
             "type": "string",
-            "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.",
             "nullable": true
           }
         },

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
@@ -68041,7 +68041,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:
@@ -74364,8 +74365,8 @@ components:
             header must be set to the value of the `content_type` property.
         commit_oid:
           type: string
-          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.
           nullable: true
       required:
       - id

diff --git a/descriptions/api.github.com/api.github.com.json b/descriptions/api.github.com/api.github.com.json
@@ -94252,7 +94252,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",
@@ -102431,7 +102431,7 @@
           },
           "commit_oid": {
             "type": "string",
-            "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.",
             "nullable": true
           }
         },

diff --git a/descriptions/api.github.com/api.github.com.yaml b/descriptions/api.github.com/api.github.com.yaml
@@ -68041,7 +68041,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:
@@ -74364,8 +74365,8 @@ components:
             header must be set to the value of the `content_type` property.
         commit_oid:
           type: string
-          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.
           nullable: true
       required:
       - id