@octokit/openapi 7.0.0 → 7.1.0

package/generated/ghes-3.2.deref.json

@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "version": "7.0.0",
+    "version": "7.1.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": {
@@ -99756,13 +99756,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"
                   }
                 }
@@ -169964,13 +169957,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"
                   }
                 }
@@ -190333,7 +190319,13 @@
                         "type": "object",
                         "properties": {
                           "type": {
-                            "type": "string"
+                            "type": "string",
+                            "enum": [
+                              "dir",
+                              "file",
+                              "submodule",
+                              "symlink"
+                            ]
                           },
                           "size": {
                             "type": "integer"
@@ -190414,7 +190406,10 @@
                       "type": "object",
                       "properties": {
                         "type": {
-                          "type": "string"
+                          "type": "string",
+                          "enum": [
+                            "file"
+                          ]
                         },
                         "encoding": {
                           "type": "string"
@@ -190507,7 +190502,10 @@
                       "type": "object",
                       "properties": {
                         "type": {
-                          "type": "string"
+                          "type": "string",
+                          "enum": [
+                            "symlink"
+                          ]
                         },
                         "target": {
                           "type": "string"
@@ -190583,12 +190581,15 @@
                       ]
                     },
                     {
-                      "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",
@@ -196486,15 +196487,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.2/rest/reference/repos#get-all-environments"
+          "url": "https://docs.github.com/enterprise-server@3.2/rest/deployments/environments#list-environments"
         },
         "parameters": [
           {
@@ -197093,7 +197094,7 @@
         "x-github": {
           "githubCloudOnly": false,
           "enabledForGitHubApps": true,
-          "category": "repos",
+          "category": "deployments",
           "subcategory": "environments"
         },
         "x-octokit": {}
@@ -197102,7 +197103,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"
         ],
@@ -197134,7 +197135,7 @@
             "name": "environment_name",
             "in": "path",
             "required": true,
-            "description": "The name of the environment",
+            "description": "The name of the environment.",
             "schema": {
               "type": "string"
             }
@@ -197688,7 +197689,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"
         ],
@@ -197720,7 +197721,7 @@
             "name": "environment_name",
             "in": "path",
             "required": true,
-            "description": "The name of the environment",
+            "description": "The name of the environment.",
             "schema": {
               "type": "string"
             }
@@ -197784,6 +197785,27 @@
                   }
                 },
                 "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
+                    }
+                  }
+                }
               }
             }
           }
@@ -198394,7 +198416,7 @@
             "name": "environment_name",
             "in": "path",
             "required": true,
-            "description": "The name of the environment",
+            "description": "The name of the environment.",
             "schema": {
               "type": "string"
             }
@@ -198414,6 +198436,559 @@
         "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.2/rest/deployments/branch-policies#list-deployment-branch-policies"
+        },
+        "parameters": [
+          {
+            "name": "owner",
+            "description": "The account owner of the repository. The name is not case sensitive.",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "repo",
+            "description": "The name of the repository. The name is not case sensitive.",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "environment_name",
+            "in": "path",
+            "required": true,
+            "description": "The name of the environment.",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "per_page",
+            "description": "The number of results per page (max 100).",
+            "in": "query",
+            "schema": {
+              "type": "integer",
+              "default": 30
+            }
+          },
+          {
+            "name": "page",
+            "description": "Page number of the results to fetch.",
+            "in": "query",
+            "schema": {
+              "type": "integer",
+              "default": 1
+            }
+          }
+        ],
+        "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": {
+                        "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/*"
+                          }
+                        }
+                      }
+                    }
+                  },
+                  "required": [
+                    "total_count",
+                    "branch_policies"
+                  ]
+                },
+                "examples": {
+                  "default": {
+                    "value": {
+                      "total_count": 2,
+                      "branch_policies": [
+                        {
+                          "id": 361471,
+                          "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE=",
+                          "name": "release/*"
+                        },
+                        {
+                          "id": 361472,
+                          "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzI=",
+                          "name": "main"
+                        }
+                      ]
+                    }
+                  }
+                }
+              }
+            }
+          }
+        },
+        "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.2/rest/deployments/branch-policies#create-deployment-branch-policy"
+        },
+        "parameters": [
+          {
+            "name": "owner",
+            "description": "The account owner of the repository. The name is not case sensitive.",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "repo",
+            "description": "The name of the repository. The name is not case sensitive.",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "environment_name",
+            "in": "path",
+            "required": true,
+            "description": "The name of the environment.",
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "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"
+                ]
+              },
+              "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": {
+                  "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/*"
+                    }
+                  }
+                },
+                "examples": {
+                  "example-wildcard": {
+                    "value": {
+                      "id": 364662,
+                      "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI=",
+                      "name": "release/*"
+                    }
+                  },
+                  "example-single-branch": {
+                    "value": {
+                      "id": 364663,
+                      "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjM=",
+                      "name": "main"
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "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.2/rest/deployments/branch-policies#get-deployment-branch-policy"
+        },
+        "parameters": [
+          {
+            "name": "owner",
+            "description": "The account owner of the repository. The name is not case sensitive.",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "repo",
+            "description": "The name of the repository. The name is not case sensitive.",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "environment_name",
+            "in": "path",
+            "required": true,
+            "description": "The name of the environment.",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "branch_policy_id",
+            "in": "path",
+            "required": true,
+            "description": "The unique identifier of the branch policy.",
+            "schema": {
+              "type": "integer"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "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/*"
+                    }
+                  }
+                },
+                "examples": {
+                  "default": {
+                    "value": {
+                      "id": 364662,
+                      "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI=",
+                      "name": "release/*"
+                    }
+                  }
+                }
+              }
+            }
+          }
+        },
+        "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.2/rest/deployments/branch-policies#update-deployment-branch-policy"
+        },
+        "parameters": [
+          {
+            "name": "owner",
+            "description": "The account owner of the repository. The name is not case sensitive.",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "repo",
+            "description": "The name of the repository. The name is not case sensitive.",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "environment_name",
+            "in": "path",
+            "required": true,
+            "description": "The name of the environment.",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "branch_policy_id",
+            "in": "path",
+            "required": true,
+            "description": "The unique identifier of the branch policy.",
+            "schema": {
+              "type": "integer"
+            }
+          }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "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"
+                ]
+              },
+              "examples": {
+                "default": {
+                  "value": {
+                    "name": "release/*"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "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/*"
+                    }
+                  }
+                },
+                "examples": {
+                  "default": {
+                    "value": {
+                      "id": 364662,
+                      "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI=",
+                      "name": "release/*"
+                    }
+                  }
+                }
+              }
+            }
+          }
+        },
+        "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.2/rest/deployments/branch-policies#delete-deployment-branch-policy"
+        },
+        "parameters": [
+          {
+            "name": "owner",
+            "description": "The account owner of the repository. The name is not case sensitive.",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "repo",
+            "description": "The name of the repository. The name is not case sensitive.",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "environment_name",
+            "in": "path",
+            "required": true,
+            "description": "The name of the environment.",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "branch_policy_id",
+            "in": "path",
+            "required": true,
+            "description": "The unique identifier of the branch policy.",
+            "schema": {
+              "type": "integer"
+            }
+          }
+        ],
+        "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",
@@ -313946,7 +314521,10 @@
                   "type": "object",
                   "properties": {
                     "type": {
-                      "type": "string"
+                      "type": "string",
+                      "enum": [
+                        "file"
+                      ]
                     },
                     "encoding": {
                       "type": "string"
@@ -314225,7 +314803,10 @@
                   "type": "object",
                   "properties": {
                     "type": {
-                      "type": "string"
+                      "type": "string",
+                      "enum": [
+                        "file"
+                      ]
                     },
                     "encoding": {
                       "type": "string"
@@ -329915,7 +330496,7 @@
             "name": "environment_name",
             "in": "path",
             "required": true,
-            "description": "The name of the environment",
+            "description": "The name of the environment.",
             "schema": {
               "type": "string"
             }
@@ -330050,7 +330631,7 @@
             "name": "environment_name",
             "in": "path",
             "required": true,
-            "description": "The name of the environment",
+            "description": "The name of the environment.",
             "schema": {
               "type": "string"
             }
@@ -330145,7 +330726,7 @@
             "name": "environment_name",
             "in": "path",
             "required": true,
-            "description": "The name of the environment",
+            "description": "The name of the environment.",
             "schema": {
               "type": "string"
             }
@@ -330236,7 +330817,7 @@
             "name": "environment_name",
             "in": "path",
             "required": true,
-            "description": "The name of the environment",
+            "description": "The name of the environment.",
             "schema": {
               "type": "string"
             }
@@ -330341,7 +330922,7 @@
             "name": "environment_name",
             "in": "path",
             "required": true,
-            "description": "The name of the environment",
+            "description": "The name of the environment.",
             "schema": {
               "type": "string"
             }