@octokit/openapi 7.11.0 → 7.12.1

package/generated/ghes-3.6.json

@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "version": "7.11.0",
+    "version": "7.12.1",
     "title": "GitHub's official OpenAPI spec + Octokit extension",
     "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
     "license": {
@@ -9017,7 +9017,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": {
@@ -9035,7 +9035,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": {
@@ -9277,7 +9277,7 @@
                     "type": "string"
                   },
                   "mode": {
-                    "description": "The rendering mode. Can be either `markdown` or `gfm`.",
+                    "description": "The rendering mode.",
                     "enum": [
                       "markdown",
                       "gfm"
@@ -14388,7 +14388,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": {
@@ -14406,7 +14406,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": {
@@ -15565,7 +15565,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": {
@@ -28879,6 +28879,22 @@
               "default": "all"
             }
           },
+          {
+            "name": "permission",
+            "description": "Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned.",
+            "in": "query",
+            "required": false,
+            "schema": {
+              "type": "string",
+              "enum": [
+                "pull",
+                "triage",
+                "push",
+                "maintain",
+                "admin"
+              ]
+            }
+          },
           {
             "$ref": "#/components/parameters/per-page"
           },
@@ -30572,7 +30588,7 @@
       },
       "put": {
         "summary": "Create or update file contents",
-        "description": "Creates a new file or replaces an existing file in a repository.",
+        "description": "Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint.",
         "tags": [
           "repos"
         ],
@@ -32649,7 +32665,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": {
@@ -33912,7 +33928,7 @@
     "/repos/{owner}/{repo}/hooks": {
       "get": {
         "summary": "List repository webhooks",
-        "description": "",
+        "description": "Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days.",
         "tags": [
           "repos"
         ],
@@ -34970,7 +34986,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": {
@@ -35015,7 +35031,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": {
@@ -39649,7 +39665,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": {
@@ -39862,7 +39878,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": {
@@ -39878,7 +39894,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": {
@@ -40084,7 +40100,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": {
@@ -40715,7 +40731,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": {
@@ -50583,7 +50599,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": {
@@ -50601,7 +50617,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": {
@@ -50961,7 +50977,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": {
@@ -53362,7 +53378,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": {
@@ -62129,7 +62145,7 @@
         "readOnly": 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",
@@ -69402,7 +69418,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.",

package/generated/github.ae-diff-to-api.github.com.deref.json

@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "version": "7.11.0",
+    "version": "7.12.1",
     "title": "GitHub's official OpenAPI spec + Octokit extension",
     "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
     "license": {
@@ -16546,7 +16546,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": {
@@ -16570,7 +16570,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": {
@@ -32009,7 +32009,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": {
@@ -32033,7 +32033,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": {
@@ -89317,6 +89317,22 @@
               "default": "all"
             }
           },
+          {
+            "name": "permission",
+            "description": "Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned.",
+            "in": "query",
+            "required": false,
+            "schema": {
+              "type": "string",
+              "enum": [
+                "pull",
+                "triage",
+                "push",
+                "maintain",
+                "admin"
+              ]
+            }
+          },
           {
             "name": "per_page",
             "description": "The number of results per page (max 100).",
@@ -104912,7 +104928,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": {
@@ -117090,7 +117106,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": {
@@ -117141,7 +117157,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": {
@@ -141101,7 +141117,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": {
@@ -141117,7 +141133,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": {
@@ -152113,7 +152129,7 @@
                         "description": "The REST API URL of the code locations for this 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",
@@ -152447,7 +152463,7 @@
                       "description": "The REST API URL of the code locations for this 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",
@@ -152711,7 +152727,7 @@
                 "type": "object",
                 "properties": {
                   "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",
@@ -152789,7 +152805,7 @@
                       "description": "The REST API URL of the code locations for this 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",
@@ -170801,7 +170817,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": {
@@ -170825,7 +170841,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": {

package/generated/github.ae-diff-to-api.github.com.json

@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "version": "7.11.0",
+    "version": "7.12.1",
     "title": "GitHub's official OpenAPI spec + Octokit extension",
     "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
     "license": {
@@ -3299,7 +3299,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": {
@@ -3317,7 +3317,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": {
@@ -4525,7 +4525,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": {
@@ -4543,7 +4543,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": {
@@ -6972,6 +6972,22 @@
               "default": "all"
             }
           },
+          {
+            "name": "permission",
+            "description": "Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned.",
+            "in": "query",
+            "required": false,
+            "schema": {
+              "type": "string",
+              "enum": [
+                "pull",
+                "triage",
+                "push",
+                "maintain",
+                "admin"
+              ]
+            }
+          },
           {
             "$ref": "#/components/parameters/per-page"
           },
@@ -7607,7 +7623,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": {
@@ -7990,7 +8006,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": {
@@ -8035,7 +8051,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": {
@@ -9114,7 +9130,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": {
@@ -9130,7 +9146,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": {
@@ -10957,7 +10973,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": {
@@ -10975,7 +10991,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": {
@@ -18863,7 +18879,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",