Merge pull request #1545 from github/openapi-update-bc56b4d377705a3219850e63e6f39d4c11c5feea6159a7ab37f764ea9f7ba8fb

Update OpenAPI 3.1 Descriptions

Author: bearcherian

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

@@ -5488,7 +5488,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": {
@@ -5506,7 +5506,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": {
@@ -5747,7 +5747,7 @@
                     "type": "string"
                   },
                   "mode": {
-                    "description": "The rendering mode. Can be either `markdown` or `gfm`.",
+                    "description": "The rendering mode.",
                     "enum": [
                       "markdown",
                       "gfm"
@@ -12482,7 +12482,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": {
@@ -12500,7 +12500,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": {
@@ -14132,7 +14132,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": {
@@ -33058,7 +33058,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": {
@@ -36081,7 +36081,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": {
@@ -36126,7 +36126,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": {
@@ -40667,7 +40667,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": {
@@ -40878,7 +40878,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": {
@@ -40894,7 +40894,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": {
@@ -41100,7 +41100,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": {
@@ -41853,7 +41853,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": {
@@ -54480,7 +54480,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": {
@@ -54498,7 +54498,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": {
@@ -54938,7 +54938,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": {
@@ -58538,7 +58538,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": {
@@ -63774,7 +63774,7 @@
         }
       },
       "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",
@@ -72532,6 +72532,16 @@
               "string",
               "null"
             ],
+            "enum": [
+              "success",
+              "failure",
+              "neutral",
+              "cancelled",
+              "skipped",
+              "timed_out",
+              "action_required",
+              null
+            ],
             "examples": [
               "success"
             ]

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

@@ -3806,8 +3806,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:
@@ -3819,8 +3818,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:
@@ -3975,7 +3973,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
@@ -8989,8 +8987,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:
@@ -9002,8 +8999,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:
@@ -10160,8 +10156,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:
@@ -23975,7 +23970,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:
@@ -26229,8 +26224,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:
@@ -26261,8 +26255,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:
@@ -29243,8 +29236,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:
@@ -29389,9 +29381,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:
@@ -29403,8 +29396,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:
@@ -29556,7 +29549,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:
@@ -30067,7 +30060,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:
@@ -39186,8 +39179,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:
@@ -39199,8 +39191,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:
@@ -39496,9 +39487,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:
@@ -42046,8 +42036,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:
@@ -45950,8 +45939,8 @@ components:
                   error:
                     type: string
     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
@@ -52272,6 +52261,15 @@ components:
           type:
           - string
           - 'null'
+          enum:
+          - success
+          - failure
+          - neutral
+          - cancelled
+          - skipped
+          - timed_out
+          - action_required
+          - 
           examples:
           - success
         started_at: