Merge pull request #1503 from github/openapi-update-6742efa1b0d928bf9f2501e263e859c43627516c030245e20f83e099a26daa72

Update OpenAPI 3.0 Descriptions

Author: mattpage

descriptions/api.github.com/api.github.com.json

@@ -20934,6 +20934,9 @@
           },
           {
             "$ref": "#/components/parameters/workflow-run-check-suite-id"
+          },
+          {
+            "$ref": "#/components/parameters/workflow-run-head-sha"
           }
         ],
         "responses": {
@@ -22582,6 +22585,9 @@
           },
           {
             "$ref": "#/components/parameters/workflow-run-check-suite-id"
+          },
+          {
+            "$ref": "#/components/parameters/workflow-run-head-sha"
           }
         ],
         "responses": {
@@ -36486,6 +36492,11 @@
                   },
                   "state_reason": {
                     "type": "string",
+                    "enum": [
+                      "completed",
+                      "not_planned",
+                      "reopened"
+                    ],
                     "nullable": true,
                     "description": "The reason for the current state",
                     "example": "not_planned"
@@ -63156,7 +63167,12 @@
             "description": "The reason for the current state",
             "example": "not_planned",
             "type": "string",
-            "nullable": true
+            "nullable": true,
+            "enum": [
+              "completed",
+              "reopened",
+              "not_planned"
+            ]
           },
           "title": {
             "description": "Title of the issue",
@@ -77791,7 +77807,12 @@
             "description": "The reason for the current state",
             "example": "not_planned",
             "type": "string",
-            "nullable": true
+            "nullable": true,
+            "enum": [
+              "completed",
+              "reopened",
+              "not_planned"
+            ]
           },
           "title": {
             "description": "Title of the issue",
@@ -112309,6 +112330,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/api.github.com/api.github.com.yaml

@@ -14965,6 +14965,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
@@ -16137,6 +16138,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
@@ -26466,6 +26468,10 @@ paths:
                   - closed
                 state_reason:
                   type: string
+                  enum:
+                  - completed
+                  - not_planned
+                  - reopened
                   nullable: true
                   description: The reason for the current state
                   example: not_planned
@@ -45744,6 +45750,10 @@ components:
           example: not_planned
           type: string
           nullable: true
+          enum:
+          - completed
+          - reopened
+          - not_planned
         title:
           description: Title of the issue
           example: Widget creation fails in Safari on OS X 10.8
@@ -57073,6 +57083,10 @@ components:
           example: not_planned
           type: string
           nullable: true
+          enum:
+          - completed
+          - reopened
+          - not_planned
         title:
           description: Title of the issue
           example: Widget creation fails in Safari on OS X 10.8
@@ -86248,6 +86262,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.