Update OpenAPI 3.1 Descriptions

github · Nov 10, 2023 · 3e26673 · 3e26673
1 parent 5d38177
commit 3e26673
Show file tree

Hide file tree

Showing 32 changed files with 88 additions and 112 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
@@ -15166,7 +15166,7 @@
                   },
                   "custom_properties": {
                     "type": "object",
-                    "description": "The custom properties for the new respository. The keys are the custom property names, and the values are the corresponding custom property values.",
+                    "description": "The custom properties for the new repository. The keys are the custom property names, and the values are the corresponding custom property values.",
                     "additionalProperties": true
                   }
                 },
@@ -105507,7 +105507,7 @@
         "type": "object",
         "properties": {
           "state": {
-            "description": "Whether code scanning default setup has been configured or not.",
+            "description": "The desired state of code scanning default setup.",
             "type": "string",
             "enum": [
               "configured",
@@ -105540,9 +105540,7 @@
             }
           }
         },
-        "required": [
-          "state"
-        ]
+        "additionalProperties": false
       },
       "code-scanning-default-setup-update-response": {
         "description": "You can use `run_url` to track the status of the run. This includes a property status and conclusion.\nYou should not rely on this always being an actions workflow run object.",

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
@@ -10851,8 +10851,8 @@ paths:
                     - `BLANK` - default to a blank commit message.
                 custom_properties:
                   type: object
-                  description: The custom properties for the new respository. The
-                    keys are the custom property names, and the values are the corresponding
+                  description: The custom properties for the new repository. The keys
+                    are the custom property names, and the values are the corresponding
                     custom property values.
                   additionalProperties: true
               required:
@@ -75551,8 +75551,7 @@ components:
       type: object
       properties:
         state:
-          description: Whether code scanning default setup has been configured or
-            not.
+          description: The desired state of code scanning default setup.
           type: string
           enum:
           - configured
@@ -75577,8 +75576,7 @@ components:
             - python
             - ruby
             - swift
-      required:
-      - state
+      additionalProperties: false
     code-scanning-default-setup-update-response:
       description: |-
         You can use `run_url` to track the status of the run. This includes a property status and conclusion.

diff --git a/descriptions-next/api.github.com/api.github.com.json b/descriptions-next/api.github.com/api.github.com.json
@@ -15166,7 +15166,7 @@
                   },
                   "custom_properties": {
                     "type": "object",
-                    "description": "The custom properties for the new respository. The keys are the custom property names, and the values are the corresponding custom property values.",
+                    "description": "The custom properties for the new repository. The keys are the custom property names, and the values are the corresponding custom property values.",
                     "additionalProperties": true
                   }
                 },
@@ -105507,7 +105507,7 @@
         "type": "object",
         "properties": {
           "state": {
-            "description": "Whether code scanning default setup has been configured or not.",
+            "description": "The desired state of code scanning default setup.",
             "type": "string",
             "enum": [
               "configured",
@@ -105540,9 +105540,7 @@
             }
           }
         },
-        "required": [
-          "state"
-        ]
+        "additionalProperties": false
       },
       "code-scanning-default-setup-update-response": {
         "description": "You can use `run_url` to track the status of the run. This includes a property status and conclusion.\nYou should not rely on this always being an actions workflow run object.",

diff --git a/descriptions-next/api.github.com/api.github.com.yaml b/descriptions-next/api.github.com/api.github.com.yaml
@@ -10851,8 +10851,8 @@ paths:
                     - `BLANK` - default to a blank commit message.
                 custom_properties:
                   type: object
-                  description: The custom properties for the new respository. The
-                    keys are the custom property names, and the values are the corresponding
+                  description: The custom properties for the new repository. The keys
+                    are the custom property names, and the values are the corresponding
                     custom property values.
                   additionalProperties: true
               required:
@@ -75551,8 +75551,7 @@ components:
       type: object
       properties:
         state:
-          description: Whether code scanning default setup has been configured or
-            not.
+          description: The desired state of code scanning default setup.
           type: string
           enum:
           - configured
@@ -75577,8 +75576,7 @@ components:
             - python
             - ruby
             - swift
-      required:
-      - state
+      additionalProperties: false
     code-scanning-default-setup-update-response:
       description: |-
         You can use `run_url` to track the status of the run. This includes a property status and conclusion.