@octokit/openapi 7.0.0 → 7.3.0

package/generated/ghes-3.6.json

@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "version": "7.0.0",
+    "version": "7.3.0",
     "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": {
@@ -18297,13 +18297,6 @@
                   "permission": {
                     "type": "string",
                     "description": "The permission to grant the team on this repository. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository.",
-                    "enum": [
-                      "pull",
-                      "push",
-                      "admin",
-                      "maintain",
-                      "triage"
-                    ],
                     "default": "push"
                   }
                 }
@@ -21007,7 +21000,7 @@
     "/repos/{owner}/{repo}/actions/permissions/access": {
       "get": {
         "summary": "Get the level of access for workflows outside of the repository",
-        "description": "Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal repositories.\nFor more information, see \"[Managing GitHub Actions settings for a repository](https://docs.github.com/enterprise-server@3.6/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the\nrepository `administration` permission to use this endpoint.",
+        "description": "Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal repositories. For more information, see \"[Managing GitHub Actions settings for a repository](https://docs.github.com/enterprise-server@3.6/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the\nrepository `administration` permission to use this endpoint.",
         "tags": [
           "actions"
         ],
@@ -21048,17 +21041,11 @@
           "category": "actions",
           "subcategory": "permissions"
         },
-        "x-octokit": {
-          "diff": {
-            "api.github.com": {
-              "type": "changed"
-            }
-          }
-        }
+        "x-octokit": {}
       },
       "put": {
         "summary": "Set the level of access for workflows outside of the repository",
-        "description": "Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal repositories.\nFor more information, see \"[Managing GitHub Actions settings for a repository](https://docs.github.com/enterprise-server@3.6/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the\nrepository `administration` permission to use this endpoint.",
+        "description": "Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal repositories. For more information, see \"[Managing GitHub Actions settings for a repository](https://docs.github.com/enterprise-server@3.6/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the\nrepository `administration` permission to use this endpoint.",
         "tags": [
           "actions"
         ],
@@ -21102,13 +21089,7 @@
           "category": "actions",
           "subcategory": "permissions"
         },
-        "x-octokit": {
-          "diff": {
-            "api.github.com": {
-              "type": "changed"
-            }
-          }
-        }
+        "x-octokit": {}
       }
     },
     "/repos/{owner}/{repo}/actions/permissions/selected-actions": {
@@ -28703,13 +28684,6 @@
                   "permission": {
                     "type": "string",
                     "description": "The permission to grant the collaborator. **Only valid on organization-owned repositories.**",
-                    "enum": [
-                      "pull",
-                      "push",
-                      "admin",
-                      "maintain",
-                      "triage"
-                    ],
                     "default": "push"
                   }
                 }
@@ -31706,15 +31680,15 @@
     },
     "/repos/{owner}/{repo}/environments": {
       "get": {
-        "summary": "Get all environments",
-        "description": "Get all environments for a repository.\n\nAnyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.",
+        "summary": "List environments",
+        "description": "Lists the environments for a repository.\n\nAnyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.",
         "tags": [
           "repos"
         ],
         "operationId": "repos/get-all-environments",
         "externalDocs": {
           "description": "API method documentation",
-          "url": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#get-all-environments"
+          "url": "https://docs.github.com/enterprise-server@3.6/rest/deployments/environments#list-environments"
         },
         "parameters": [
           {
@@ -31763,7 +31737,7 @@
         "x-github": {
           "githubCloudOnly": false,
           "enabledForGitHubApps": true,
-          "category": "repos",
+          "category": "deployments",
           "subcategory": "environments"
         },
         "x-octokit": {}
@@ -31772,7 +31746,7 @@
     "/repos/{owner}/{repo}/environments/{environment_name}": {
       "get": {
         "summary": "Get an environment",
-        "description": "Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.",
+        "description": "**Note:** To get information about name patterns that branches must match in order to deploy to this environment, see \"[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy).\"\n\nAnyone with read access to the repository can use this endpoint. If the\nrepository is private, you must use an access token with the `repo` scope. GitHub\nApps must have the `actions:read` permission to use this endpoint.",
         "tags": [
           "repos"
         ],
@@ -31819,7 +31793,7 @@
       },
       "put": {
         "summary": "Create or update an environment",
-        "description": "Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"[Environments](/actions/reference/environments#environment-protection-rules).\"\n\n**Note:** Although you can use this operation to specify that only branches that match specified name patterns can deploy to this environment, you must use the UI to set the name patterns. For more information, see \"[Environments](/actions/reference/environments#deployment-branches).\"\n\n**Note:** To create or update secrets for an environment, see \"[Secrets](/rest/reference/actions#secrets).\"\n\nYou must authenticate using an access token with the repo scope to use this endpoint.",
+        "description": "Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"[Environments](/actions/reference/environments#environment-protection-rules).\"\n\n**Note:** To create or update name patterns that branches must match in order to deploy to this environment, see \"[Deployment branch policies](/rest/deployments/branch-policies).\"\n\n**Note:** To create or update secrets for an environment, see \"[Secrets](/rest/reference/actions#secrets).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.",
         "tags": [
           "repos"
         ],
@@ -31869,10 +31843,31 @@
                     }
                   },
                   "deployment_branch_policy": {
-                    "$ref": "#/components/schemas/deployment-branch-policy"
+                    "$ref": "#/components/schemas/deployment-branch-policy-settings"
                   }
                 },
                 "additionalProperties": false
+              },
+              "examples": {
+                "default": {
+                  "value": {
+                    "wait_timer": 30,
+                    "reviewers": [
+                      {
+                        "type": "User",
+                        "id": 1
+                      },
+                      {
+                        "type": "Team",
+                        "id": 1
+                      }
+                    ],
+                    "deployment_branch_policy": {
+                      "protected_branches": false,
+                      "custom_branch_policies": true
+                    }
+                  }
+                }
               }
             }
           }
@@ -31948,6 +31943,315 @@
         "x-octokit": {}
       }
     },
+    "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies": {
+      "get": {
+        "summary": "List deployment branch policies",
+        "description": "Lists the deployment branch policies for an environment.\n\nAnyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.",
+        "tags": [
+          "repos"
+        ],
+        "operationId": "repos/list-deployment-branch-policies",
+        "externalDocs": {
+          "description": "API method documentation",
+          "url": "https://docs.github.com/enterprise-server@3.6/rest/deployments/branch-policies#list-deployment-branch-policies"
+        },
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/owner"
+          },
+          {
+            "$ref": "#/components/parameters/repo"
+          },
+          {
+            "$ref": "#/components/parameters/environment-name"
+          },
+          {
+            "$ref": "#/components/parameters/per-page"
+          },
+          {
+            "$ref": "#/components/parameters/page"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "total_count": {
+                      "description": "The number of deployment branch policies for the environment.",
+                      "type": "integer",
+                      "example": 2
+                    },
+                    "branch_policies": {
+                      "type": "array",
+                      "items": {
+                        "$ref": "#/components/schemas/deployment-branch-policy"
+                      }
+                    }
+                  },
+                  "required": [
+                    "total_count",
+                    "branch_policies"
+                  ]
+                },
+                "examples": {
+                  "default": {
+                    "$ref": "#/components/examples/deployment-branch-policies-list"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "x-github": {
+          "githubCloudOnly": false,
+          "enabledForGitHubApps": true,
+          "category": "deployments",
+          "subcategory": "branch-policies"
+        },
+        "x-octokit": {}
+      },
+      "post": {
+        "summary": "Create a deployment branch policy",
+        "description": "Creates a deployment branch policy for an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.",
+        "tags": [
+          "repos"
+        ],
+        "operationId": "repos/create-deployment-branch-policy",
+        "externalDocs": {
+          "description": "API method documentation",
+          "url": "https://docs.github.com/enterprise-server@3.6/rest/deployments/branch-policies#create-deployment-branch-policy"
+        },
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/owner"
+          },
+          {
+            "$ref": "#/components/parameters/repo"
+          },
+          {
+            "$ref": "#/components/parameters/environment-name"
+          }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/deployment-branch-policy-name-pattern"
+              },
+              "examples": {
+                "example-wildcard": {
+                  "summary": "Example of a wildcard name pattern",
+                  "value": {
+                    "name": "release/*"
+                  }
+                },
+                "example-single-branch": {
+                  "summary": "Example of a single branch name pattern",
+                  "value": {
+                    "name": "main"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/deployment-branch-policy"
+                },
+                "examples": {
+                  "example-wildcard": {
+                    "$ref": "#/components/examples/deployment-branch-policy-wildcard"
+                  },
+                  "example-single-branch": {
+                    "$ref": "#/components/examples/deployment-branch-policy-single-branch"
+                  }
+                }
+              }
+            }
+          },
+          "303": {
+            "description": "Response if the same branch name pattern already exists"
+          },
+          "404": {
+            "description": "Not Found or `deployment_branch_policy.custom_branch_policies` property for the environment is set to false"
+          }
+        },
+        "x-github": {
+          "githubCloudOnly": false,
+          "enabledForGitHubApps": true,
+          "category": "deployments",
+          "subcategory": "branch-policies"
+        },
+        "x-octokit": {}
+      }
+    },
+    "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}": {
+      "get": {
+        "summary": "Get a deployment branch policy",
+        "description": "Gets a deployment branch policy for an environment.\n\nAnyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.",
+        "tags": [
+          "repos"
+        ],
+        "operationId": "repos/get-deployment-branch-policy",
+        "externalDocs": {
+          "description": "API method documentation",
+          "url": "https://docs.github.com/enterprise-server@3.6/rest/deployments/branch-policies#get-deployment-branch-policy"
+        },
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/owner"
+          },
+          {
+            "$ref": "#/components/parameters/repo"
+          },
+          {
+            "$ref": "#/components/parameters/environment-name"
+          },
+          {
+            "$ref": "#/components/parameters/branch-policy-id"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/deployment-branch-policy"
+                },
+                "examples": {
+                  "default": {
+                    "$ref": "#/components/examples/deployment-branch-policy-wildcard"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "x-github": {
+          "githubCloudOnly": false,
+          "enabledForGitHubApps": true,
+          "category": "deployments",
+          "subcategory": "branch-policies"
+        },
+        "x-octokit": {}
+      },
+      "put": {
+        "summary": "Update a deployment branch policy",
+        "description": "Updates a deployment branch policy for an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.",
+        "tags": [
+          "repos"
+        ],
+        "operationId": "repos/update-deployment-branch-policy",
+        "externalDocs": {
+          "description": "API method documentation",
+          "url": "https://docs.github.com/enterprise-server@3.6/rest/deployments/branch-policies#update-deployment-branch-policy"
+        },
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/owner"
+          },
+          {
+            "$ref": "#/components/parameters/repo"
+          },
+          {
+            "$ref": "#/components/parameters/environment-name"
+          },
+          {
+            "$ref": "#/components/parameters/branch-policy-id"
+          }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/deployment-branch-policy-name-pattern"
+              },
+              "examples": {
+                "default": {
+                  "value": {
+                    "name": "release/*"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/deployment-branch-policy"
+                },
+                "examples": {
+                  "default": {
+                    "$ref": "#/components/examples/deployment-branch-policy-wildcard"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "x-github": {
+          "githubCloudOnly": false,
+          "enabledForGitHubApps": true,
+          "category": "deployments",
+          "subcategory": "branch-policies"
+        },
+        "x-octokit": {}
+      },
+      "delete": {
+        "summary": "Delete a deployment branch policy",
+        "description": "Deletes a deployment branch policy for an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.",
+        "tags": [
+          "repos"
+        ],
+        "operationId": "repos/delete-deployment-branch-policy",
+        "externalDocs": {
+          "description": "API method documentation",
+          "url": "https://docs.github.com/enterprise-server@3.6/rest/deployments/branch-policies#delete-deployment-branch-policy"
+        },
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/owner"
+          },
+          {
+            "$ref": "#/components/parameters/repo"
+          },
+          {
+            "$ref": "#/components/parameters/environment-name"
+          },
+          {
+            "$ref": "#/components/parameters/branch-policy-id"
+          }
+        ],
+        "responses": {
+          "204": {
+            "description": "Response"
+          }
+        },
+        "x-github": {
+          "githubCloudOnly": false,
+          "enabledForGitHubApps": true,
+          "category": "deployments",
+          "subcategory": "branch-policies"
+        },
+        "x-octokit": {}
+      }
+    },
     "/repos/{owner}/{repo}/events": {
       "get": {
         "summary": "List repository events",
@@ -53243,6 +53547,12 @@
               "text/plain": {
                 "schema": {
                   "type": "string"
+                },
+                "examples": {
+                  "default": {
+                    "summary": "Example response",
+                    "value": "Responsive is better than fast"
+                  }
                 }
               }
             }
@@ -53398,6 +53708,50 @@
         }
       }
     },
+    "/enterprises/{enterprise}/consumed-licenses": {
+      "get": {
+        "summary": "List enterprise consumed licenses",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com",
+        "tags": [
+          "enterprise-admin"
+        ],
+        "operationId": "enterprise-admin/get-consumed-licenses",
+        "externalDocs": {
+          "description": "API method documentation",
+          "url": "https://docs.github.com/rest/reference/enterprise-admin#list-enterprise-consumed-licenses"
+        },
+        "x-octokit": {
+          "api.github.com": "removed"
+        },
+        "responses": {
+          "501": {
+            "description": "Not Implemented"
+          }
+        }
+      }
+    },
+    "/enterprises/{enterprise}/license-sync-status": {
+      "get": {
+        "summary": "Get a license sync status",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com",
+        "tags": [
+          "enterprise-admin"
+        ],
+        "operationId": "enterprise-admin/get-license-sync-status",
+        "externalDocs": {
+          "description": "API method documentation",
+          "url": "https://docs.github.com/rest/reference/enterprise-admin#get-a-license-sync-status"
+        },
+        "x-octokit": {
+          "api.github.com": "removed"
+        },
+        "responses": {
+          "501": {
+            "description": "Not Implemented"
+          }
+        }
+      }
+    },
     "/enterprises/{enterprise}/settings/billing/actions": {
       "get": {
         "summary": "Get GitHub Actions billing for an enterprise",
@@ -58002,6 +58356,14 @@
               "write"
             ]
           },
+          "organization_custom_roles": {
+            "type": "string",
+            "description": "The level of permission to grant the access token for custom roles management.",
+            "enum": [
+              "read",
+              "write"
+            ]
+          },
           "deployments": {
             "type": "string",
             "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -72245,7 +72607,13 @@
           "type": "object",
           "properties": {
             "type": {
-              "type": "string"
+              "type": "string",
+              "enum": [
+                "dir",
+                "file",
+                "submodule",
+                "symlink"
+              ]
             },
             "size": {
               "type": "integer"
@@ -72326,7 +72694,10 @@
         "type": "object",
         "properties": {
           "type": {
-            "type": "string"
+            "type": "string",
+            "enum": [
+              "file"
+            ]
           },
           "encoding": {
             "type": "string"
@@ -72419,7 +72790,10 @@
         "type": "object",
         "properties": {
           "type": {
-            "type": "string"
+            "type": "string",
+            "enum": [
+              "symlink"
+            ]
           },
           "target": {
             "type": "string"
@@ -72495,12 +72869,15 @@
         ]
       },
       "content-submodule": {
-        "title": "Symlink Content",
-        "description": "An object describing a symlink",
+        "title": "Submodule Content",
+        "description": "An object describing a submodule",
         "type": "object",
         "properties": {
           "type": {
-            "type": "string"
+            "type": "string",
+            "enum": [
+              "submodule"
+            ]
           },
           "submodule_git_url": {
             "type": "string",
@@ -73038,7 +73415,7 @@
         "example": 30,
         "description": "The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days)."
       },
-      "deployment-branch-policy": {
+      "deployment-branch-policy-settings": {
         "type": "object",
         "description": "The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`.",
         "properties": {
@@ -73195,7 +73572,7 @@
             }
           },
           "deployment_branch_policy": {
-            "$ref": "#/components/schemas/deployment-branch-policy"
+            "$ref": "#/components/schemas/deployment-branch-policy-settings"
           }
         },
         "required": [
@@ -73208,6 +73585,41 @@
           "updated_at"
         ]
       },
+      "deployment-branch-policy": {
+        "title": "Deployment branch policy",
+        "description": "Details of a deployment branch policy.",
+        "type": "object",
+        "properties": {
+          "id": {
+            "description": "The unique identifier of the branch policy.",
+            "type": "integer",
+            "example": 361471
+          },
+          "node_id": {
+            "type": "string",
+            "example": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE="
+          },
+          "name": {
+            "description": "The name pattern that branches must match in order to deploy to the environment.",
+            "type": "string",
+            "example": "release/*"
+          }
+        }
+      },
+      "deployment-branch-policy-name-pattern": {
+        "title": "Deployment branch policy name pattern",
+        "type": "object",
+        "properties": {
+          "name": {
+            "description": "The name pattern that branches must match in order to deploy to the environment.\n\nWildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*/*`.\nFor more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch).",
+            "type": "string",
+            "example": "release/*"
+          }
+        },
+        "required": [
+          "name"
+        ]
+      },
       "short-blob": {
         "title": "Short Blob",
         "description": "Short Blob",
@@ -95767,6 +96179,37 @@
           }
         }
       },
+      "deployment-branch-policies-list": {
+        "value": {
+          "total_count": 2,
+          "branch_policies": [
+            {
+              "id": 361471,
+              "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE=",
+              "name": "release/*"
+            },
+            {
+              "id": 361472,
+              "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzI=",
+              "name": "main"
+            }
+          ]
+        }
+      },
+      "deployment-branch-policy-wildcard": {
+        "value": {
+          "id": 364662,
+          "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI=",
+          "name": "release/*"
+        }
+      },
+      "deployment-branch-policy-single-branch": {
+        "value": {
+          "id": 364663,
+          "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjM=",
+          "name": "main"
+        }
+      },
       "repo-events-items": {
         "value": [
           {
@@ -104759,11 +105202,20 @@
         "name": "environment_name",
         "in": "path",
         "required": true,
-        "description": "The name of the environment",
+        "description": "The name of the environment.",
         "schema": {
           "type": "string"
         }
       },
+      "branch-policy-id": {
+        "name": "branch_policy_id",
+        "in": "path",
+        "required": true,
+        "description": "The unique identifier of the branch policy.",
+        "schema": {
+          "type": "integer"
+        }
+      },
       "invitation-id": {
         "name": "invitation_id",
         "description": "The unique identifier of the invitation.",