@octokit/openapi 7.11.0 → 7.12.1

package/generated/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": {
@@ -20129,7 +20129,7 @@
     "/enterprises/{enterprise}/consumed-licenses": {
       "get": {
         "summary": "List enterprise consumed licenses",
-        "description": "Lists the license consumption information for all users, including those from connected servers, associated with an enterprise.\nTo use this endpoint, you must be an enterprise admin, and you must use an access\ntoken with the `read:enterprise` scope.",
+        "description": "Lists the license consumption information for all users, including those from connected servers, associated with an enterprise.\nTo use this endpoint, you must be an enterprise admin, and you must use an access\ntoken with the `read:enterprise` scope.\n\n**Note:** The license consumption API endpoints for enterprise accounts are currently\nin Beta and are subject to change.",
         "tags": [
           "enterprise-admin"
         ],
@@ -20209,7 +20209,15 @@
                           },
                           "github_com_enterprise_role": {
                             "type": "string",
-                            "nullable": true
+                            "nullable": true,
+                            "description": "Deprecated: The most permissive enterprise role for a user."
+                          },
+                          "github_com_enterprise_roles": {
+                            "type": "array",
+                            "description": "All enterprise roles for a user.",
+                            "items": {
+                              "type": "string"
+                            }
                           },
                           "visual_studio_subscription_user": {
                             "type": "boolean"
@@ -20280,6 +20288,9 @@
                             "org2:Owner"
                           ],
                           "github_com_enterprise_role": "owner",
+                          "github_com_enterprise_roles": [
+                            "owner"
+                          ],
                           "visual_studio_subscription_user": false,
                           "github_com_verified_domain_emails": [
                             "monalisa@github.com"
@@ -20308,6 +20319,7 @@
                           "license_type": "enterprise",
                           "github_com_member_roles": [],
                           "github_com_enterprise_role": "",
+                          "github_com_enterprise_roles": [],
                           "visual_studio_subscription_user": false,
                           "github_com_verified_domain_emails": [],
                           "github_com_saml_name_id": "",
@@ -20603,7 +20615,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",
@@ -37186,7 +37198,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": {
@@ -37210,7 +37222,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": {
@@ -40518,7 +40530,7 @@
                     "type": "string"
                   },
                   "mode": {
-                    "description": "The rendering mode. Can be either `markdown` or `gfm`.",
+                    "description": "The rendering mode.",
                     "enum": [
                       "markdown",
                       "gfm"
@@ -83043,7 +83055,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": {
@@ -83067,7 +83079,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": {
@@ -103120,7 +103132,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": {
@@ -108077,7 +108089,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",
@@ -141941,7 +141953,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.",
@@ -161717,7 +161738,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.",
@@ -162333,7 +162363,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.",
@@ -218757,6 +218796,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).",
@@ -240461,7 +240516,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"
         ],
@@ -252885,7 +252940,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": {
@@ -263445,7 +263500,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"
         ],
@@ -273761,7 +273816,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": {
@@ -273812,7 +273867,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": {
@@ -334463,7 +334518,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": {
@@ -335443,7 +335498,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": {
@@ -335459,7 +335514,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": {
@@ -343609,7 +343664,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": {
@@ -358143,7 +358198,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": {
@@ -381910,7 +381965,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",
@@ -382402,7 +382457,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",
@@ -382802,7 +382857,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",
@@ -382880,7 +382935,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",
@@ -452342,7 +452397,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": {
@@ -452366,7 +452421,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": {
@@ -456593,7 +456648,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": {
@@ -502352,7 +502407,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/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": {
@@ -3579,7 +3579,7 @@
     "/enterprises/{enterprise}/consumed-licenses": {
       "get": {
         "summary": "List enterprise consumed licenses",
-        "description": "Lists the license consumption information for all users, including those from connected servers, associated with an enterprise.\nTo use this endpoint, you must be an enterprise admin, and you must use an access\ntoken with the `read:enterprise` scope.",
+        "description": "Lists the license consumption information for all users, including those from connected servers, associated with an enterprise.\nTo use this endpoint, you must be an enterprise admin, and you must use an access\ntoken with the `read:enterprise` scope.\n\n**Note:** The license consumption API endpoints for enterprise accounts are currently\nin Beta and are subject to change.",
         "tags": [
           "enterprise-admin"
         ],
@@ -5531,7 +5531,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": {
@@ -5549,7 +5549,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": {
@@ -5791,7 +5791,7 @@
                     "type": "string"
                   },
                   "mode": {
-                    "description": "The rendering mode. Can be either `markdown` or `gfm`.",
+                    "description": "The rendering mode.",
                     "enum": [
                       "markdown",
                       "gfm"
@@ -12637,7 +12637,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": {
@@ -12655,7 +12655,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": {
@@ -14309,7 +14309,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": {
@@ -29439,6 +29439,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"
           },
@@ -31166,7 +31182,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"
         ],
@@ -33328,7 +33344,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": {
@@ -34593,7 +34609,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"
         ],
@@ -36370,7 +36386,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": {
@@ -36415,7 +36431,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": {
@@ -40935,7 +40951,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": {
@@ -41148,7 +41164,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": {
@@ -41164,7 +41180,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": {
@@ -41370,7 +41386,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": {
@@ -42131,7 +42147,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": {
@@ -54998,7 +55014,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": {
@@ -55016,7 +55032,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": {
@@ -55499,7 +55515,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": {
@@ -59145,7 +59161,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": {
@@ -63849,7 +63865,15 @@
                 },
                 "github_com_enterprise_role": {
                   "type": "string",
-                  "nullable": true
+                  "nullable": true,
+                  "description": "Deprecated: The most permissive enterprise role for a user."
+                },
+                "github_com_enterprise_roles": {
+                  "type": "array",
+                  "description": "All enterprise roles for a user.",
+                  "items": {
+                    "type": "string"
+                  }
                 },
                 "visual_studio_subscription_user": {
                   "type": "boolean"
@@ -63943,7 +63967,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",
@@ -72538,7 +72562,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.",
@@ -90734,6 +90767,9 @@
                 "org2:Owner"
               ],
               "github_com_enterprise_role": "owner",
+              "github_com_enterprise_roles": [
+                "owner"
+              ],
               "visual_studio_subscription_user": false,
               "github_com_verified_domain_emails": [
                 "monalisa@github.com"
@@ -90762,6 +90798,7 @@
               "license_type": "enterprise",
               "github_com_member_roles": [],
               "github_com_enterprise_role": "",
+              "github_com_enterprise_roles": [],
               "visual_studio_subscription_user": false,
               "github_com_verified_domain_emails": [],
               "github_com_saml_name_id": "",

package/generated/ghes-3.2-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.2-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": {