@octokit/openapi 6.1.4 → 6.3.0

package/generated/github.ae.deref.json

@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "version": "6.1.4",
+    "version": "6.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": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
@@ -37996,7 +37996,7 @@
                   "selected_repository_ids": {
                     "type": "array",
                     "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/github-ae@latest/rest/reference/actions#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/github-ae@latest/rest/reference/actions#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/github-ae@latest/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints.",
-                    "items": { "type": "string" }
+                    "items": { "type": "integer" }
                   }
                 },
                 "required": ["visibility"]
@@ -38007,7 +38007,7 @@
                     "encrypted_value": "c2VjcmV0",
                     "key_id": "012345678912345678",
                     "visibility": "selected",
-                    "selected_repository_ids": ["1296269", "1296280"]
+                    "selected_repository_ids": [1296269, 1296280]
                   }
                 }
               }
@@ -38025,7 +38025,8 @@
                   "type": "object",
                   "properties": {},
                   "additionalProperties": false
-                }
+                },
+                "examples": { "default": { "value": null } }
               }
             }
           },
@@ -38037,7 +38038,7 @@
           "category": "actions",
           "subcategory": "secrets"
         },
-        "x-octokit": {}
+        "x-octokit": { "diff": { "api.github.com": { "type": "changed" } } }
       },
       "delete": {
         "summary": "Delete an organization secret",
@@ -77780,6 +77781,24 @@
                 "schema": { "type": "string" }
               }
             }
+          },
+          "410": {
+            "description": "Gone",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "title": "Basic Error",
+                  "description": "Basic Error",
+                  "type": "object",
+                  "properties": {
+                    "message": { "type": "string" },
+                    "documentation_url": { "type": "string" },
+                    "url": { "type": "string" },
+                    "status": { "type": "string" }
+                  }
+                }
+              }
+            }
           }
         },
         "x-github": {
@@ -97253,7 +97272,7 @@
           "category": "repos",
           "subcategory": "autolinks"
         },
-        "x-octokit": {}
+        "x-octokit": { "diff": { "api.github.com": { "type": "changed" } } }
       },
       "post": {
         "summary": "Create an autolink reference for a repository",
@@ -97293,7 +97312,7 @@
                   },
                   "url_template": {
                     "type": "string",
-                    "description": "The URL must contain <num> for the reference number."
+                    "description": "The URL must contain `<num>` for the reference number."
                   }
                 },
                 "required": ["key_prefix", "url_template"]
@@ -97400,7 +97419,7 @@
           "category": "repos",
           "subcategory": "autolinks"
         },
-        "x-octokit": {}
+        "x-octokit": { "diff": { "api.github.com": { "type": "changed" } } }
       }
     },
     "/repos/{owner}/{repo}/autolinks/{autolink_id}": {
@@ -97497,7 +97516,7 @@
           "category": "repos",
           "subcategory": "autolinks"
         },
-        "x-octokit": {}
+        "x-octokit": { "diff": { "api.github.com": { "type": "changed" } } }
       },
       "delete": {
         "summary": "Delete an autolink reference from a repository",
@@ -152384,6 +152403,71 @@
                       "created_at"
                     ]
                   }
+                },
+                "examples": {
+                  "200-response": {
+                    "value": [
+                      {
+                        "id": "22249084964",
+                        "type": "PushEvent",
+                        "actor": {
+                          "id": 583231,
+                          "login": "octocat",
+                          "display_login": "octocat",
+                          "gravatar_id": "",
+                          "url": "https://api.github.com/users/octocat",
+                          "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
+                        },
+                        "repo": {
+                          "id": 1296269,
+                          "name": "octocat/Hello-World",
+                          "url": "https://api.github.com/repos/octocat/Hello-World"
+                        },
+                        "payload": {
+                          "push_id": 10115855396,
+                          "size": 1,
+                          "distinct_size": 1,
+                          "ref": "refs/heads/master",
+                          "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
+                          "before": "883efe034920928c47fe18598c01249d1a9fdabd",
+                          "commits": [
+                            {
+                              "sha": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
+                              "author": {
+                                "email": "octocat@github.com",
+                                "name": "Monalisa Octocat"
+                              },
+                              "message": "commit",
+                              "distinct": true,
+                              "url": "https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300"
+                            }
+                          ]
+                        },
+                        "public": true,
+                        "created_at": "2022-06-09T12:47:28Z"
+                      },
+                      {
+                        "id": "22237752260",
+                        "type": "WatchEvent",
+                        "actor": {
+                          "id": 583231,
+                          "login": "octocat",
+                          "display_login": "octocat",
+                          "gravatar_id": "",
+                          "url": "https://api.github.com/users/octocat",
+                          "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
+                        },
+                        "repo": {
+                          "id": 1296269,
+                          "name": "octocat/Hello-World",
+                          "url": "https://api.github.com/repos/octocat/Hello-World"
+                        },
+                        "payload": { "action": "started" },
+                        "public": true,
+                        "created_at": "2022-06-08T23:29:25Z"
+                      }
+                    ]
+                  }
                 }
               }
             }
@@ -186339,7 +186423,7 @@
         "operationId": "issues/remove-assignees",
         "externalDocs": {
           "description": "API method documentation",
-          "url": "https://docs.github.com/github-ae@latest/rest/reference/issues#remove-assignees-from-an-issue"
+          "url": "https://docs.github.com/rest/reference/issues#remove-assignees-from-an-issue"
         },
         "parameters": [
           {
@@ -186365,6 +186449,7 @@
           }
         ],
         "requestBody": {
+          "required": true,
           "content": {
             "application/json": {
               "schema": {
@@ -186375,7 +186460,8 @@
                     "description": "Usernames of assignees to remove from an issue. _NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise._",
                     "items": { "type": "string" }
                   }
-                }
+                },
+                "required": ["assignees"]
               },
               "examples": {
                 "default": { "value": { "assignees": ["hubot", "other_user"] } }
@@ -187806,6 +187892,9 @@
                             "allow_auto_merge": { "type": "boolean" },
                             "delete_branch_on_merge": { "type": "boolean" },
                             "allow_update_branch": { "type": "boolean" },
+                            "use_squash_pr_title_as_default": {
+                              "type": "boolean"
+                            },
                             "allow_merge_commit": { "type": "boolean" },
                             "subscribers_count": { "type": "integer" },
                             "network_count": { "type": "integer" }
@@ -187836,6 +187925,11 @@
                           "type": "boolean",
                           "example": false
                         },
+                        "use_squash_pr_title_as_default": {
+                          "type": "boolean",
+                          "description": "Whether a squash merge commit can use the pull request title as default.",
+                          "default": false
+                        },
                         "allow_merge_commit": {
                           "description": "Whether to allow merge commits for pull requests.",
                           "default": true,
@@ -308313,99 +308407,6 @@
         "x-octokit": {}
       }
     },
-    "/repos/{owner}/{repo}/community/code_of_conduct": {
-      "get": {
-        "summary": "Get the code of conduct for a repository",
-        "description": "Returns the contents of the repository's code of conduct file, if one is detected.\n\nA code of conduct is detected if there is a file named `CODE_OF_CONDUCT` in the root directory of the repository. GitHub detects which code of conduct it is using fuzzy matching.",
-        "tags": ["codes-of-conduct"],
-        "operationId": "codes-of-conduct/get-for-repo",
-        "externalDocs": {
-          "description": "API method documentation",
-          "url": "https://docs.github.com/rest/reference/codes-of-conduct#get-the-code-of-conduct-for-a-repository"
-        },
-        "parameters": [
-          {
-            "name": "owner",
-            "in": "path",
-            "required": true,
-            "schema": { "type": "string" }
-          },
-          {
-            "name": "repo",
-            "in": "path",
-            "required": true,
-            "schema": { "type": "string" }
-          }
-        ],
-        "responses": {
-          "200": {
-            "description": "Response",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "title": "Code Of Conduct",
-                  "description": "Code Of Conduct",
-                  "type": "object",
-                  "properties": {
-                    "key": {
-                      "type": "string",
-                      "example": "contributor_covenant"
-                    },
-                    "name": {
-                      "type": "string",
-                      "example": "Contributor Covenant"
-                    },
-                    "url": {
-                      "type": "string",
-                      "format": "uri",
-                      "example": "https://api.github.com/codes_of_conduct/contributor_covenant"
-                    },
-                    "body": {
-                      "type": "string",
-                      "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n                  to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n                  posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n"
-                    },
-                    "html_url": {
-                      "type": "string",
-                      "format": "uri",
-                      "nullable": true
-                    }
-                  },
-                  "required": ["url", "html_url", "key", "name"]
-                },
-                "examples": {
-                  "default": {
-                    "value": {
-                      "key": "contributor_covenant",
-                      "name": "Contributor Covenant",
-                      "url": "https://github.com/LindseyB/cosee/blob/master/CODE_OF_CONDUCT.md",
-                      "body": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\nto any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\nposting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at lindseyb@github.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n",
-                      "html_url": "https://github.com/LindseyB/cosee/blob/master/CODE_OF_CONDUCT.md"
-                    }
-                  }
-                }
-              }
-            }
-          }
-        },
-        "x-github": {
-          "githubCloudOnly": false,
-          "enabledForGitHubApps": true,
-          "previews": [
-            {
-              "required": true,
-              "name": "scarlet-witch",
-              "note": "The Codes of Conduct API is currently available for developers to preview.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.scarlet-witch-preview+json\n```"
-            }
-          ],
-          "category": "codes-of-conduct",
-          "subcategory": null,
-          "removalDate": "2021-09-29",
-          "deprecationDate": "2021-09-29"
-        },
-        "deprecated": true,
-        "x-octokit": {}
-      }
-    },
     "/applications/grants": {
       "get": {
         "summary": "List your grants",
@@ -308590,6 +308591,20 @@
         "responses": { "501": { "description": "Not Implemented" } }
       }
     },
+    "/enterprises/{enterprise}/actions/oidc/customization/issuer": {
+      "put": {
+        "summary": "Set the GitHub Actions OIDC custom issuer policy for an enterprise",
+        "description": "This endpoint does not exist github.ae. It was added in api.github.com",
+        "tags": ["actions"],
+        "operationId": "actions/set-actions-oidc-custom-issuer-policy-for-enterprise",
+        "externalDocs": {
+          "description": "API method documentation",
+          "url": "https://docs.github.com/rest/reference/actions/oidc#set-actions-oidc-custom-issuer-policy-for-enterprise"
+        },
+        "x-octokit": { "api.github.com": "removed" },
+        "responses": { "501": { "description": "Not Implemented" } }
+      }
+    },
     "/enterprises/{enterprise}/actions/permissions/workflow": {
       "get": {
         "summary": "Get default workflow permissions for an enterprise",
@@ -308956,6 +308971,32 @@
         "responses": { "501": { "description": "Not Implemented" } }
       }
     },
+    "/orgs/{org}/actions/oidc/customization/sub": {
+      "get": {
+        "summary": "Get the customization template for an OIDC subject claim for an organization",
+        "description": "This endpoint does not exist github.ae. It was added in api.github.com",
+        "tags": ["oidc"],
+        "operationId": "oidc/get-oidc-custom-sub-template-for-org",
+        "externalDocs": {
+          "description": "API method documentation",
+          "url": "https://docs.github.com/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-an-organization"
+        },
+        "x-octokit": { "api.github.com": "removed" },
+        "responses": { "501": { "description": "Not Implemented" } }
+      },
+      "put": {
+        "summary": "Set the customization template for an OIDC subject claim for an organization",
+        "description": "This endpoint does not exist github.ae. It was added in api.github.com",
+        "tags": ["oidc"],
+        "operationId": "oidc/update-oidc-custom-sub-template-for-org",
+        "externalDocs": {
+          "description": "API method documentation",
+          "url": "https://docs.github.com/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization"
+        },
+        "x-octokit": { "api.github.com": "removed" },
+        "responses": { "501": { "description": "Not Implemented" } }
+      }
+    },
     "/orgs/{org}/actions/permissions/workflow": {
       "get": {
         "summary": "Get default workflow permissions for an organization",
@@ -309190,6 +309231,20 @@
         "responses": { "501": { "description": "Not Implemented" } }
       }
     },
+    "/orgs/{org}/codespaces": {
+      "get": {
+        "summary": "List codespaces for the organization",
+        "description": "This endpoint does not exist github.ae. It was added in api.github.com",
+        "tags": ["codespaces"],
+        "operationId": "codespaces/list-in-organization",
+        "externalDocs": {
+          "description": "API method documentation",
+          "url": "https://docs.github.com/rest/reference/codespaces#list-in-organization"
+        },
+        "x-octokit": { "api.github.com": "removed" },
+        "responses": { "501": { "description": "Not Implemented" } }
+      }
+    },
     "/orgs/{org}/credential-authorizations": {
       "get": {
         "summary": "List SAML SSO authorizations for an organization",
@@ -309456,6 +309511,34 @@
         "responses": { "501": { "description": "Not Implemented" } }
       }
     },
+    "/orgs/{org}/members/{username}/codespaces/{codespace_name}": {
+      "delete": {
+        "summary": "Delete a codespace from the organization",
+        "description": "This endpoint does not exist github.ae. It was added in api.github.com",
+        "tags": ["codespaces"],
+        "operationId": "codespaces/delete-from-organization",
+        "externalDocs": {
+          "description": "API method documentation",
+          "url": "https://docs.github.com/rest/reference/codespaces"
+        },
+        "x-octokit": { "api.github.com": "removed" },
+        "responses": { "501": { "description": "Not Implemented" } }
+      }
+    },
+    "/orgs/{org}/members/{username}/codespaces/{codespace_name}/stop": {
+      "post": {
+        "summary": "Stop a codespace for an organization user",
+        "description": "This endpoint does not exist github.ae. It was added in api.github.com",
+        "tags": ["codespaces"],
+        "operationId": "codespaces/stop-in-organization",
+        "externalDocs": {
+          "description": "API method documentation",
+          "url": "https://docs.github.com/rest/reference/codespaces"
+        },
+        "x-octokit": { "api.github.com": "removed" },
+        "responses": { "501": { "description": "Not Implemented" } }
+      }
+    },
     "/orgs/{org}/migrations/{migration_id}/archive": {
       "get": {
         "summary": "Download an organization migration archive",
@@ -309808,6 +309891,46 @@
         "responses": { "501": { "description": "Not Implemented" } }
       }
     },
+    "/repos/{owner}/{repo}/actions/caches": {
+      "get": {
+        "summary": "List GitHub Actions caches for a repository",
+        "description": "This endpoint does not exist github.ae. It was added in api.github.com",
+        "tags": ["actions"],
+        "operationId": "actions/get-actions-cache-list",
+        "externalDocs": {
+          "description": "API method documentation",
+          "url": "https://docs.github.com/rest/actions/cache#list-github-actions-caches-for-a-repository"
+        },
+        "x-octokit": { "api.github.com": "removed" },
+        "responses": { "501": { "description": "Not Implemented" } }
+      },
+      "delete": {
+        "summary": "Delete GitHub Actions caches for a repository (using a cache key)",
+        "description": "This endpoint does not exist github.ae. It was added in api.github.com",
+        "tags": ["actions"],
+        "operationId": "actions/delete-actions-cache-by-key",
+        "externalDocs": {
+          "description": "API method documentation",
+          "url": "https://docs.github.com/rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key"
+        },
+        "x-octokit": { "api.github.com": "removed" },
+        "responses": { "501": { "description": "Not Implemented" } }
+      }
+    },
+    "/repos/{owner}/{repo}/actions/caches/{cache_id}": {
+      "delete": {
+        "summary": "Delete a GitHub Actions cache for a repository (using a cache ID)",
+        "description": "This endpoint does not exist github.ae. It was added in api.github.com",
+        "tags": ["actions"],
+        "operationId": "actions/delete-actions-cache-by-id",
+        "externalDocs": {
+          "description": "API method documentation",
+          "url": "https://docs.github.com/rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id"
+        },
+        "x-octokit": { "api.github.com": "removed" },
+        "responses": { "501": { "description": "Not Implemented" } }
+      }
+    },
     "/repos/{owner}/{repo}/actions/jobs/{job_id}/rerun": {
       "post": {
         "summary": "Re-run a job from a workflow run",
@@ -309822,6 +309945,32 @@
         "responses": { "501": { "description": "Not Implemented" } }
       }
     },
+    "/repos/{owner}/{repo}/actions/oidc/customization/sub": {
+      "get": {
+        "summary": "Get the opt-out flag of an OIDC subject claim customization for a repository",
+        "description": "This endpoint does not exist github.ae. It was added in api.github.com",
+        "tags": ["actions"],
+        "operationId": "actions/get-custom-oidc-sub-claim-for-repo",
+        "externalDocs": {
+          "description": "API method documentation",
+          "url": "https://docs.github.com/rest/actions/oidc#get-the-opt-out-flag-of-an-oidc-subject-claim-customization-for-a-repository"
+        },
+        "x-octokit": { "api.github.com": "removed" },
+        "responses": { "501": { "description": "Not Implemented" } }
+      },
+      "put": {
+        "summary": "Set the opt-out flag of an OIDC subject claim customization for a repository",
+        "description": "This endpoint does not exist github.ae. It was added in api.github.com",
+        "tags": ["actions"],
+        "operationId": "actions/set-custom-oidc-sub-claim-for-repo",
+        "externalDocs": {
+          "description": "API method documentation",
+          "url": "https://docs.github.com/rest/actions/oidc#set-the-opt-out-flag-of-an-oidc-subject-claim-customization-for-a-repository"
+        },
+        "x-octokit": { "api.github.com": "removed" },
+        "responses": { "501": { "description": "Not Implemented" } }
+      }
+    },
     "/repos/{owner}/{repo}/actions/permissions/access": {
       "get": {
         "summary": "Get the level of access for workflows outside of the repository",