@octokit/openapi 7.11.0 → 7.12.1

package/generated/ghes-3.4.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": {
@@ -32271,7 +32271,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",
@@ -48249,7 +48249,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": {
@@ -48273,7 +48273,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": {
@@ -51499,7 +51499,7 @@
                     "type": "string"
                   },
                   "mode": {
-                    "description": "The rendering mode. Can be either `markdown` or `gfm`.",
+                    "description": "The rendering mode.",
                     "enum": [
                       "markdown",
                       "gfm"
@@ -82188,7 +82188,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": {
@@ -82212,7 +82212,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": {
@@ -92004,7 +92004,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": {
@@ -96749,7 +96749,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",
@@ -127576,7 +127576,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.",
@@ -140902,7 +140911,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.",
@@ -186444,6 +186462,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).",
@@ -207406,7 +207440,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"
         ],
@@ -219127,7 +219161,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": {
@@ -229301,7 +229335,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"
         ],
@@ -237452,7 +237486,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": {
@@ -237503,7 +237537,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": {
@@ -297107,7 +297141,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": {
@@ -298087,7 +298121,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": {
@@ -298103,7 +298137,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": {
@@ -306083,7 +306117,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": {
@@ -315508,7 +315542,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": {
@@ -339011,7 +339045,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",
@@ -339349,7 +339383,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",
@@ -339613,7 +339647,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",
@@ -339691,7 +339725,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",
@@ -378402,7 +378436,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": {
@@ -378426,7 +378460,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": {
@@ -381949,7 +381983,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": {
@@ -413381,7 +413415,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": {

package/generated/ghes-3.4.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": {
@@ -8375,7 +8375,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": {
@@ -8393,7 +8393,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": {
@@ -8635,7 +8635,7 @@
                     "type": "string"
                   },
                   "mode": {
-                    "description": "The rendering mode. Can be either `markdown` or `gfm`.",
+                    "description": "The rendering mode.",
                     "enum": [
                       "markdown",
                       "gfm"
@@ -13399,7 +13399,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": {
@@ -13417,7 +13417,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": {
@@ -14552,7 +14552,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": {
@@ -27153,6 +27153,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"
           },
@@ -28864,7 +28880,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"
         ],
@@ -30873,7 +30889,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": {
@@ -32136,7 +32152,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"
         ],
@@ -33200,7 +33216,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": {
@@ -33245,7 +33261,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": {
@@ -37843,7 +37859,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": {
@@ -38056,7 +38072,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": {
@@ -38072,7 +38088,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": {
@@ -38278,7 +38294,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": {
@@ -38909,7 +38925,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": {
@@ -48521,7 +48537,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": {
@@ -48539,7 +48555,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": {
@@ -48899,7 +48915,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": {
@@ -51311,7 +51327,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": {
@@ -56437,7 +56453,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",
@@ -63174,7 +63190,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/ghes-3.5-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": {

package/generated/ghes-3.5-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": {