Merge pull request #1504 from github/openapi-update-d38ed88c693c4d428c196cc19ac03103e22478252e832fb5ae549ff27bb40b15

Update OpenAPI 3.1 Descriptions

Author: mattpage

descriptions-next/api.github.com/api.github.com.json

@@ -21050,6 +21050,9 @@
           },
           {
             "$ref": "#/components/parameters/workflow-run-check-suite-id"
+          },
+          {
+            "$ref": "#/components/parameters/workflow-run-head-sha"
           }
         ],
         "responses": {
@@ -22708,6 +22711,9 @@
           },
           {
             "$ref": "#/components/parameters/workflow-run-check-suite-id"
+          },
+          {
+            "$ref": "#/components/parameters/workflow-run-head-sha"
           }
         ],
         "responses": {
@@ -36697,6 +36703,12 @@
                       "string",
                       "null"
                     ],
+                    "enum": [
+                      "completed",
+                      "not_planned",
+                      "reopened",
+                      null
+                    ],
                     "description": "The reason for the current state",
                     "examples": [
                       "not_planned"
@@ -63992,6 +64004,12 @@
               "string",
               "null"
             ],
+            "enum": [
+              "completed",
+              "reopened",
+              "not_planned",
+              null
+            ],
             "examples": [
               "not_planned"
             ]
@@ -115214,6 +115232,15 @@
           "type": "integer"
         }
       },
+      "workflow-run-head-sha": {
+        "name": "head_sha",
+        "description": "Only returns workflow runs that are associated with the specified `head_sha`.",
+        "in": "query",
+        "required": false,
+        "schema": {
+          "type": "string"
+        }
+      },
       "run-id": {
         "name": "run_id",
         "description": "The unique identifier of the workflow run.",

descriptions-next/api.github.com/api.github.com.yaml

@@ -15020,6 +15020,7 @@ paths:
       - "$ref": "#/components/parameters/created"
       - "$ref": "#/components/parameters/exclude-pull-requests"
       - "$ref": "#/components/parameters/workflow-run-check-suite-id"
+      - "$ref": "#/components/parameters/workflow-run-head-sha"
       responses:
         '200':
           description: Response
@@ -16197,6 +16198,7 @@ paths:
       - "$ref": "#/components/parameters/created"
       - "$ref": "#/components/parameters/exclude-pull-requests"
       - "$ref": "#/components/parameters/workflow-run-check-suite-id"
+      - "$ref": "#/components/parameters/workflow-run-head-sha"
       responses:
         '200':
           description: Response
@@ -26571,6 +26573,11 @@ paths:
                   type:
                   - string
                   - 'null'
+                  enum:
+                  - completed
+                  - not_planned
+                  - reopened
+                  - 
                   description: The reason for the current state
                   examples:
                   - not_planned
@@ -46066,6 +46073,11 @@ components:
           type:
           - string
           - 'null'
+          enum:
+          - completed
+          - reopened
+          - not_planned
+          - 
           examples:
           - not_planned
         title:
@@ -86839,6 +86851,14 @@ components:
       in: query
       schema:
         type: integer
+    workflow-run-head-sha:
+      name: head_sha
+      description: Only returns workflow runs that are associated with the specified
+        `head_sha`.
+      in: query
+      required: false
+      schema:
+        type: string
     run-id:
       name: run_id
       description: The unique identifier of the workflow run.