Merge pull request #1544 from github/openapi-update-1a0d4a090c24a01032928bd3de95e282eaf8640ad17bed058221f5c29ba2fa64

Update OpenAPI 3.0 Descriptions

Author: bearcherian

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

@@ -5448,7 +5448,7 @@
           },
           {
             "name": "state",
-            "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.",
+            "description": "Indicates the state of the issues to return.",
             "in": "query",
             "required": false,
             "schema": {
@@ -5466,7 +5466,7 @@
           },
           {
             "name": "sort",
-            "description": "What to sort results by. Can be either `created`, `updated`, `comments`.",
+            "description": "What to sort results by.",
             "in": "query",
             "required": false,
             "schema": {
@@ -5707,7 +5707,7 @@
                     "type": "string"
                   },
                   "mode": {
-                    "description": "The rendering mode. Can be either `markdown` or `gfm`.",
+                    "description": "The rendering mode.",
                     "enum": [
                       "markdown",
                       "gfm"
@@ -12426,7 +12426,7 @@
           },
           {
             "name": "state",
-            "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.",
+            "description": "Indicates the state of the issues to return.",
             "in": "query",
             "required": false,
             "schema": {
@@ -12444,7 +12444,7 @@
           },
           {
             "name": "sort",
-            "description": "What to sort results by. Can be either `created`, `updated`, `comments`.",
+            "description": "What to sort results by.",
             "in": "query",
             "required": false,
             "schema": {
@@ -14062,7 +14062,7 @@
           },
           {
             "name": "state",
-            "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.",
+            "description": "Indicates the state of the projects to return.",
             "in": "query",
             "required": false,
             "schema": {
@@ -32890,7 +32890,7 @@
           },
           {
             "name": "sort",
-            "description": "The sort order. Can be either `newest`, `oldest`, or `stargazers`.",
+            "description": "The sort order. `stargazers` will sort by star count.",
             "in": "query",
             "required": false,
             "schema": {
@@ -35891,7 +35891,7 @@
           },
           {
             "name": "state",
-            "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.",
+            "description": "Indicates the state of the issues to return.",
             "in": "query",
             "required": false,
             "schema": {
@@ -35936,7 +35936,7 @@
           },
           {
             "name": "sort",
-            "description": "What to sort results by. Can be either `created`, `updated`, `comments`.",
+            "description": "What to sort results by.",
             "in": "query",
             "required": false,
             "schema": {
@@ -40440,7 +40440,7 @@
           },
           {
             "name": "state",
-            "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.",
+            "description": "Indicates the state of the projects to return.",
             "in": "query",
             "required": false,
             "schema": {
@@ -40651,7 +40651,7 @@
           },
           {
             "name": "sort",
-            "description": "What to sort results by. Can be either `created`, `updated`, `popularity` (comment count) or `long-running` (age, filtering by pulls updated in the last month).",
+            "description": "What to sort results by. `popularity` will sort by the number of comments. `long-running` will sort by date created and will limit the results to pull requests that have been open for more than a month and have had activity within the past month.",
             "in": "query",
             "required": false,
             "schema": {
@@ -40667,7 +40667,7 @@
           },
           {
             "name": "direction",
-            "description": "The direction of the sort. Can be either `asc` or `desc`. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`.",
+            "description": "The direction of the sort. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`.",
             "in": "query",
             "required": false,
             "schema": {
@@ -40871,7 +40871,7 @@
           },
           {
             "name": "direction",
-            "description": "Can be either `asc` or `desc`. Ignored without `sort` parameter.",
+            "description": "The direction to sort results. Ignored without `sort` parameter.",
             "in": "query",
             "required": false,
             "schema": {
@@ -41622,7 +41622,7 @@
           },
           {
             "name": "direction",
-            "description": "Can be either `asc` or `desc`. Ignored without `sort` parameter.",
+            "description": "The direction to sort results. Ignored without `sort` parameter.",
             "in": "query",
             "required": false,
             "schema": {
@@ -54177,7 +54177,7 @@
           },
           {
             "name": "state",
-            "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.",
+            "description": "Indicates the state of the issues to return.",
             "in": "query",
             "required": false,
             "schema": {
@@ -54195,7 +54195,7 @@
           },
           {
             "name": "sort",
-            "description": "What to sort results by. Can be either `created`, `updated`, `comments`.",
+            "description": "What to sort results by.",
             "in": "query",
             "required": false,
             "schema": {
@@ -54633,7 +54633,7 @@
         "parameters": [
           {
             "name": "state",
-            "description": "Indicates the state of the memberships to return. Can be either `active` or `pending`. If not specified, the API returns both active and pending memberships.",
+            "description": "Indicates the state of the memberships to return. If not specified, the API returns both active and pending memberships.",
             "in": "query",
             "required": false,
             "schema": {
@@ -58181,7 +58181,7 @@
           },
           {
             "name": "state",
-            "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.",
+            "description": "Indicates the state of the projects to return.",
             "in": "query",
             "required": false,
             "schema": {
@@ -62901,7 +62901,7 @@
         "nullable": true
       },
       "secret-scanning-alert-state": {
-        "description": "Sets the state of the secret scanning alert. Can be either `open` or `resolved`. You must provide `resolution` when you set the state to `resolved`.",
+        "description": "Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`.",
         "type": "string",
         "enum": [
           "open",
@@ -71502,7 +71502,16 @@
             "description": "The outcome of the job.",
             "example": "success",
             "type": "string",
-            "nullable": true
+            "nullable": true,
+            "enum": [
+              "success",
+              "failure",
+              "neutral",
+              "cancelled",
+              "skipped",
+              "timed_out",
+              "action_required"
+            ]
           },
           "started_at": {
             "description": "The time that the job started, in ISO 8601 format.",

descriptions/api.github.com/api.github.com.yaml

@@ -3788,8 +3788,7 @@ paths:
           - all
           default: assigned
       - name: state
-        description: Indicates the state of the issues to return. Can be either `open`,
-          `closed`, or `all`.
+        description: Indicates the state of the issues to return.
         in: query
         required: false
         schema:
@@ -3801,8 +3800,7 @@ paths:
           default: open
       - "$ref": "#/components/parameters/labels"
       - name: sort
-        description: What to sort results by. Can be either `created`, `updated`,
-          `comments`.
+        description: What to sort results by.
         in: query
         required: false
         schema:
@@ -3957,7 +3955,7 @@ paths:
                   description: The Markdown text to render in HTML.
                   type: string
                 mode:
-                  description: The rendering mode. Can be either `markdown` or `gfm`.
+                  description: The rendering mode.
                   enum:
                   - markdown
                   - gfm
@@ -8963,8 +8961,7 @@ paths:
           - all
           default: assigned
       - name: state
-        description: Indicates the state of the issues to return. Can be either `open`,
-          `closed`, or `all`.
+        description: Indicates the state of the issues to return.
         in: query
         required: false
         schema:
@@ -8976,8 +8973,7 @@ paths:
           default: open
       - "$ref": "#/components/parameters/labels"
       - name: sort
-        description: What to sort results by. Can be either `created`, `updated`,
-          `comments`.
+        description: What to sort results by.
         in: query
         required: false
         schema:
@@ -10127,8 +10123,7 @@ paths:
       parameters:
       - "$ref": "#/components/parameters/org"
       - name: state
-        description: Indicates the state of the projects to return. Can be either
-          `open`, `closed`, or `all`.
+        description: Indicates the state of the projects to return.
         in: query
         required: false
         schema:
@@ -23894,7 +23889,7 @@ paths:
       - "$ref": "#/components/parameters/owner"
       - "$ref": "#/components/parameters/repo"
       - name: sort
-        description: The sort order. Can be either `newest`, `oldest`, or `stargazers`.
+        description: The sort order. `stargazers` will sort by star count.
         in: query
         required: false
         schema:
@@ -26137,8 +26132,7 @@ paths:
         schema:
           type: string
       - name: state
-        description: Indicates the state of the issues to return. Can be either `open`,
-          `closed`, or `all`.
+        description: Indicates the state of the issues to return.
         in: query
         required: false
         schema:
@@ -26169,8 +26163,7 @@ paths:
           type: string
       - "$ref": "#/components/parameters/labels"
       - name: sort
-        description: What to sort results by. Can be either `created`, `updated`,
-          `comments`.
+        description: What to sort results by.
         in: query
         required: false
         schema:
@@ -29129,8 +29122,7 @@ paths:
       - "$ref": "#/components/parameters/owner"
       - "$ref": "#/components/parameters/repo"
       - name: state
-        description: Indicates the state of the projects to return. Can be either
-          `open`, `closed`, or `all`.
+        description: Indicates the state of the projects to return.
         in: query
         required: false
         schema:
@@ -29275,9 +29267,10 @@ paths:
         schema:
           type: string
       - name: sort
-        description: What to sort results by. Can be either `created`, `updated`,
-          `popularity` (comment count) or `long-running` (age, filtering by pulls
-          updated in the last month).
+        description: What to sort results by. `popularity` will sort by the number
+          of comments. `long-running` will sort by date created and will limit the
+          results to pull requests that have been open for more than a month and have
+          had activity within the past month.
         in: query
         required: false
         schema:
@@ -29289,8 +29282,8 @@ paths:
           - long-running
           default: created
       - name: direction
-        description: 'The direction of the sort. Can be either `asc` or `desc`. Default:
-          `desc` when sort is `created` or sort is not specified, otherwise `asc`.'
+        description: 'The direction of the sort. Default: `desc` when sort is `created`
+          or sort is not specified, otherwise `asc`.'
         in: query
         required: false
         schema:
@@ -29441,7 +29434,7 @@ paths:
           - updated
           - created_at
       - name: direction
-        description: Can be either `asc` or `desc`. Ignored without `sort` parameter.
+        description: The direction to sort results. Ignored without `sort` parameter.
         in: query
         required: false
         schema:
@@ -29951,7 +29944,7 @@ paths:
       - "$ref": "#/components/parameters/pull-number"
       - "$ref": "#/components/parameters/sort"
       - name: direction
-        description: Can be either `asc` or `desc`. Ignored without `sort` parameter.
+        description: The direction to sort results. Ignored without `sort` parameter.
         in: query
         required: false
         schema:
@@ -39034,8 +39027,7 @@ paths:
           - all
           default: assigned
       - name: state
-        description: Indicates the state of the issues to return. Can be either `open`,
-          `closed`, or `all`.
+        description: Indicates the state of the issues to return.
         in: query
         required: false
         schema:
@@ -39047,8 +39039,7 @@ paths:
           default: open
       - "$ref": "#/components/parameters/labels"
       - name: sort
-        description: What to sort results by. Can be either `created`, `updated`,
-          `comments`.
+        description: What to sort results by.
         in: query
         required: false
         schema:
@@ -39343,9 +39334,8 @@ paths:
         url: https://docs.github.com/rest/reference/orgs#list-organization-memberships-for-the-authenticated-user
       parameters:
       - name: state
-        description: Indicates the state of the memberships to return. Can be either
-          `active` or `pending`. If not specified, the API returns both active and
-          pending memberships.
+        description: Indicates the state of the memberships to return. If not specified,
+          the API returns both active and pending memberships.
         in: query
         required: false
         schema:
@@ -41868,8 +41858,7 @@ paths:
       parameters:
       - "$ref": "#/components/parameters/username"
       - name: state
-        description: Indicates the state of the projects to return. Can be either
-          `open`, `closed`, or `all`.
+        description: Indicates the state of the projects to return.
         in: query
         required: false
         schema:
@@ -45563,8 +45552,8 @@ components:
       readOnly: true
       nullable: true
     secret-scanning-alert-state:
-      description: Sets the state of the secret scanning alert. Can be either `open`
-        or `resolved`. You must provide `resolution` when you set the state to `resolved`.
+      description: Sets the state of the secret scanning alert. You must provide `resolution`
+        when you set the state to `resolved`.
       type: string
       enum:
       - open
@@ -52322,6 +52311,14 @@ components:
           example: success
           type: string
           nullable: true
+          enum:
+          - success
+          - failure
+          - neutral
+          - cancelled
+          - skipped
+          - timed_out
+          - action_required
         started_at:
           description: The time that the job started, in ISO 8601 format.
           example: '2019-08-08T08:00:00-07:00'