feat: add new request parameters and response attributes, plus some s…

…mall description fixes (see PR body) (#291) WIP: schema updates Co-authored-by: Octokit Bot <[email protected]>
octokit · Sep 13, 2022 · 58951a7 · 58951a7
1 parent e0972bc
commit 58951a7
Show file tree

Hide file tree

Showing 34 changed files with 656 additions and 64 deletions.
diff --git a/cache/api.github.com.deref.json b/cache/api.github.com.deref.json
@@ -20057,7 +20057,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"
         ],
@@ -20137,7 +20137,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"
@@ -20208,6 +20216,9 @@
                             "org2:Owner"
                           ],
                           "github_com_enterprise_role": "owner",
+                          "github_com_enterprise_roles": [
+                            "owner"
+                          ],
                           "visual_studio_subscription_user": false,
                           "github_com_verified_domain_emails": [
                             "[email protected]"
@@ -20236,6 +20247,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": "",
@@ -218292,6 +218304,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).",
@@ -239971,7 +239999,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"
         ],
@@ -262912,7 +262940,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"
         ],

diff --git a/cache/api.github.com.json b/cache/api.github.com.json
@@ -3507,7 +3507,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"
         ],
@@ -28974,6 +28974,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"
           },
@@ -30676,7 +30692,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"
         ],
@@ -34060,7 +34076,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"
         ],
@@ -62688,7 +62704,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"
@@ -89573,6 +89597,9 @@
                 "org2:Owner"
               ],
               "github_com_enterprise_role": "owner",
+              "github_com_enterprise_roles": [
+                "owner"
+              ],
               "visual_studio_subscription_user": false,
               "github_com_verified_domain_emails": [
                 "[email protected]"
@@ -89601,6 +89628,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": "",

diff --git a/cache/ghes-3.2.deref.json b/cache/ghes-3.2.deref.json
@@ -170193,6 +170193,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).",
@@ -191430,7 +191446,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"
         ],
@@ -212818,7 +212834,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"
         ],

diff --git a/cache/ghes-3.2.json b/cache/ghes-3.2.json
@@ -24968,6 +24968,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"
           },
@@ -26800,7 +26816,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"
         ],
@@ -29811,7 +29827,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"
         ],

diff --git a/cache/ghes-3.3.deref.json b/cache/ghes-3.3.deref.json
@@ -172026,6 +172026,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).",
@@ -193241,7 +193257,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"
         ],
@@ -214633,7 +214649,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"
         ],

diff --git a/cache/ghes-3.3.json b/cache/ghes-3.3.json
@@ -24893,6 +24893,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"
           },
@@ -26669,7 +26685,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"
         ],
@@ -29618,7 +29634,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"
         ],

diff --git a/cache/ghes-3.4.deref.json b/cache/ghes-3.4.deref.json
@@ -185883,6 +185883,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).",
@@ -206791,7 +206807,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"
         ],
@@ -228639,7 +228655,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"
         ],