@octokit/openapi 6.1.4 → 6.3.0

package/generated/ghes-3.2.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" },
@@ -8629,7 +8629,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/enterprise-server@3.2/rest/reference/actions#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.2/rest/reference/actions#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.2/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints.",
-                    "items": { "type": "string" }
+                    "items": { "type": "integer" }
                   }
                 },
                 "required": ["visibility"]
@@ -8640,7 +8640,7 @@
                     "encrypted_value": "c2VjcmV0",
                     "key_id": "012345678912345678",
                     "visibility": "selected",
-                    "selected_repository_ids": ["1296269", "1296280"]
+                    "selected_repository_ids": [1296269, 1296280]
                   }
                 }
               }
@@ -8652,7 +8652,8 @@
             "description": "Response when creating a secret",
             "content": {
               "application/json": {
-                "schema": { "$ref": "#/components/schemas/empty-object" }
+                "schema": { "$ref": "#/components/schemas/empty-object" },
+                "examples": { "default": { "value": null } }
               }
             }
           },
@@ -8881,6 +8882,11 @@
                 "schema": {
                   "type": "array",
                   "items": { "$ref": "#/components/schemas/event" }
+                },
+                "examples": {
+                  "200-response": {
+                    "$ref": "#/components/examples/public-org-events-items"
+                  }
                 }
               }
             }
@@ -14275,7 +14281,8 @@
             "headers": {
               "Location": { "$ref": "#/components/headers/location" }
             }
-          }
+          },
+          "410": { "$ref": "#/components/responses/gone" }
         },
         "x-github": {
           "githubCloudOnly": false,
@@ -21812,7 +21819,7 @@
                     }
                   },
                   "deployment_branch_policy": {
-                    "$ref": "#/components/schemas/deployment_branch_policy"
+                    "$ref": "#/components/schemas/deployment-branch-policy"
                   }
                 },
                 "additionalProperties": false
@@ -21897,6 +21904,11 @@
                 "schema": {
                   "type": "array",
                   "items": { "$ref": "#/components/schemas/event" }
+                },
+                "examples": {
+                  "200-response": {
+                    "$ref": "#/components/examples/repo-events-items"
+                  }
                 }
               }
             }
@@ -24598,7 +24610,7 @@
         "operationId": "issues/remove-assignees",
         "externalDocs": {
           "description": "API method documentation",
-          "url": "https://docs.github.com/enterprise-server@3.2/rest/reference/issues#remove-assignees-from-an-issue"
+          "url": "https://docs.github.com/rest/reference/issues#remove-assignees-from-an-issue"
         },
         "parameters": [
           { "$ref": "#/components/parameters/owner" },
@@ -24606,6 +24618,7 @@
           { "$ref": "#/components/parameters/issue-number" }
         ],
         "requestBody": {
+          "required": true,
           "content": {
             "application/json": {
               "schema": {
@@ -24616,7 +24629,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"] } }
@@ -31416,7 +31430,8 @@
             "description": "Response when creating a secret",
             "content": {
               "application/json": {
-                "schema": { "$ref": "#/components/schemas/empty-object" }
+                "schema": { "$ref": "#/components/schemas/empty-object" },
+                "examples": { "default": { "value": null } }
               }
             }
           },
@@ -34512,6 +34527,18 @@
                     }
                   }
                 ]
+              },
+              "examples": {
+                "default": {
+                  "summary": "Example adding multiple email addresses",
+                  "value": {
+                    "emails": [
+                      "octocat@github.com",
+                      "mona@github.com",
+                      "octocat@octocat.org"
+                    ]
+                  }
+                }
               }
             }
           }
@@ -34588,6 +34615,14 @@
                     "required": ["emails"]
                   }
                 ]
+              },
+              "examples": {
+                "default": {
+                  "summary": "Example deleting multiple email accounts",
+                  "value": {
+                    "emails": ["octocat@github.com", "mona@github.com"]
+                  }
+                }
               }
             }
           }
@@ -40680,7 +40715,7 @@
         ],
         "nullable": true
       },
-      "author_association": {
+      "author-association": {
         "title": "author_association",
         "type": "string",
         "example": "OWNER",
@@ -40846,7 +40881,7 @@
             "$ref": "#/components/schemas/nullable-integration"
           },
           "author_association": {
-            "$ref": "#/components/schemas/author_association"
+            "$ref": "#/components/schemas/author-association"
           },
           "reactions": { "$ref": "#/components/schemas/reaction-rollup" }
         },
@@ -40912,7 +40947,7 @@
           },
           "issue_url": { "type": "string", "format": "uri" },
           "author_association": {
-            "$ref": "#/components/schemas/author_association"
+            "$ref": "#/components/schemas/author-association"
           },
           "performed_via_github_app": {
             "$ref": "#/components/schemas/nullable-integration"
@@ -41387,7 +41422,7 @@
             "example": "2011-04-18T23:23:56Z"
           },
           "author_association": {
-            "$ref": "#/components/schemas/author_association"
+            "$ref": "#/components/schemas/author-association"
           }
         },
         "required": [
@@ -47107,7 +47142,7 @@
           "created_at": { "type": "string", "format": "date-time" },
           "updated_at": { "type": "string", "format": "date-time" },
           "author_association": {
-            "$ref": "#/components/schemas/author_association"
+            "$ref": "#/components/schemas/author-association"
           },
           "reactions": { "$ref": "#/components/schemas/reaction-rollup" }
         },
@@ -47152,7 +47187,7 @@
         "properties": { "href": { "type": "string" } },
         "required": ["href"]
       },
-      "auto_merge": {
+      "auto-merge": {
         "title": "Auto merge",
         "description": "The status of auto merging a pull request.",
         "type": "object",
@@ -47368,9 +47403,9 @@
             ]
           },
           "author_association": {
-            "$ref": "#/components/schemas/author_association"
+            "$ref": "#/components/schemas/author-association"
           },
-          "auto_merge": { "$ref": "#/components/schemas/auto_merge" },
+          "auto_merge": { "$ref": "#/components/schemas/auto-merge" },
           "draft": {
             "description": "Indicates whether or not the pull request is a draft.",
             "example": false,
@@ -48094,7 +48129,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": {
         "type": "object",
         "description": "The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`.",
         "properties": {
@@ -48215,7 +48250,7 @@
             }
           },
           "deployment_branch_policy": {
-            "$ref": "#/components/schemas/deployment_branch_policy"
+            "$ref": "#/components/schemas/deployment-branch-policy"
           }
         },
         "required": [
@@ -48732,7 +48767,7 @@
             "$ref": "#/components/schemas/nullable-integration"
           },
           "author_association": {
-            "$ref": "#/components/schemas/author_association"
+            "$ref": "#/components/schemas/author-association"
           },
           "reactions": { "$ref": "#/components/schemas/reaction-rollup" }
         },
@@ -48862,7 +48897,7 @@
           },
           "rename": { "$ref": "#/components/schemas/issue-event-rename" },
           "author_association": {
-            "$ref": "#/components/schemas/author_association"
+            "$ref": "#/components/schemas/author-association"
           },
           "lock_reason": { "type": "string", "nullable": true },
           "performed_via_github_app": {
@@ -49565,7 +49600,7 @@
           },
           "issue_url": { "type": "string", "format": "uri" },
           "author_association": {
-            "$ref": "#/components/schemas/author_association"
+            "$ref": "#/components/schemas/author-association"
           },
           "performed_via_github_app": {
             "$ref": "#/components/schemas/nullable-integration"
@@ -49780,7 +49815,7 @@
           "body_html": { "type": "string" },
           "body_text": { "type": "string" },
           "author_association": {
-            "$ref": "#/components/schemas/author_association"
+            "$ref": "#/components/schemas/author-association"
           }
         },
         "required": [
@@ -49887,7 +49922,7 @@
             "example": "https://api.github.com/repos/octocat/Hello-World/pulls/1"
           },
           "author_association": {
-            "$ref": "#/components/schemas/author_association"
+            "$ref": "#/components/schemas/author-association"
           },
           "_links": {
             "type": "object",
@@ -51326,9 +51361,9 @@
             ]
           },
           "author_association": {
-            "$ref": "#/components/schemas/author_association"
+            "$ref": "#/components/schemas/author-association"
           },
-          "auto_merge": { "$ref": "#/components/schemas/auto_merge" },
+          "auto_merge": { "$ref": "#/components/schemas/auto-merge" },
           "draft": {
             "description": "Indicates whether or not the pull request is a draft.",
             "example": false,
@@ -51483,7 +51518,7 @@
           "body_html": { "type": "string" },
           "body_text": { "type": "string" },
           "author_association": {
-            "$ref": "#/components/schemas/author_association"
+            "$ref": "#/components/schemas/author-association"
           }
         },
         "required": [
@@ -51558,7 +51593,7 @@
             "example": "https://api.github.com/repos/octocat/Hello-World/pulls/1"
           },
           "author_association": {
-            "$ref": "#/components/schemas/author_association"
+            "$ref": "#/components/schemas/author-association"
           },
           "_links": {
             "type": "object",
@@ -52166,7 +52201,7 @@
           "body": { "type": "string" },
           "score": { "type": "number" },
           "author_association": {
-            "$ref": "#/components/schemas/author_association"
+            "$ref": "#/components/schemas/author-association"
           },
           "draft": { "type": "boolean" },
           "repository": { "$ref": "#/components/schemas/repository" },
@@ -58137,6 +58172,69 @@
           ]
         }
       },
+      "public-org-events-items": {
+        "value": [
+          {
+            "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": "octo-org/octo-repo",
+              "url": "https://api.github.com/repos/octo-org/octo-repo"
+            },
+            "payload": { "action": "started" },
+            "public": true,
+            "created_at": "2022-06-08T23:29:25Z"
+          },
+          {
+            "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": "octo-org/octo-repo",
+              "url": "https://api.github.com/repos/octo-org/oct-repo"
+            },
+            "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/octo-org/oct-repo/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300"
+                }
+              ]
+            },
+            "public": true,
+            "created_at": "2022-06-09T12:47:28Z"
+          }
+        ]
+      },
       "org-hook-items": {
         "value": [
           {
@@ -65769,6 +65867,69 @@
           }
         }
       },
+      "repo-events-items": {
+        "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"
+          }
+        ]
+      },
       "minimal-repository-items-2": {
         "value": [
           {

package/generated/ghes-3.3-anicca-diff-to-ghes-3.4.deref.json

@@ -2577,6 +2577,29 @@
           }
         }
       },
+      "/orgs/{org}/actions/secrets/{secret_name}": {
+        "put": {
+          "request_body": {
+            "content_changed": {
+              "changed": {
+                "application/json": {
+                  "schema_changed": {
+                    "properties_changed": {
+                      "changed": {
+                        "selected_repository_ids": {
+                          "items_changed": {
+                            "type_changed": { "to": "integer" }
+                          }
+                        }
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      },
       "/orgs/{org}/audit-log": {
         "get": {
           "parameters": {

package/generated/ghes-3.3-diff-to-ghes-3.4.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" },
@@ -13738,6 +13738,101 @@
         "x-octokit": { "diff": { "ghes-3.4": { "type": "changed" } } }
       }
     },
+    "/orgs/{org}/actions/secrets/{secret_name}": {
+      "put": {
+        "summary": "Create or update an organization secret",
+        "description": "Creates or updates an organization secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access\ntoken with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to\nuse this endpoint.\n\n#### Example encrypting a secret using Node.js\n\nEncrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.\n\n```\nconst sodium = require('tweetsodium');\n\nconst key = \"base64-encoded-public-key\";\nconst value = \"plain-text-secret\";\n\n// Convert the message and key to Uint8Array's (Buffer implements that interface)\nconst messageBytes = Buffer.from(value);\nconst keyBytes = Buffer.from(key, 'base64');\n\n// Encrypt using LibSodium.\nconst encryptedBytes = sodium.seal(messageBytes, keyBytes);\n\n// Base64 the encrypted secret\nconst encrypted = Buffer.from(encryptedBytes).toString('base64');\n\nconsole.log(encrypted);\n```\n\n\n#### Example encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n  \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n  public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n  sealed_box = public.SealedBox(public_key)\n  encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n  return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```",
+        "tags": ["actions"],
+        "operationId": "actions/create-or-update-org-secret",
+        "externalDocs": {
+          "description": "API method documentation",
+          "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#create-or-update-an-organization-secret"
+        },
+        "parameters": [
+          {
+            "name": "org",
+            "description": "The organization name. The name is not case sensitive.",
+            "in": "path",
+            "required": true,
+            "schema": { "type": "string" }
+          },
+          {
+            "name": "secret_name",
+            "description": "The name of the secret.",
+            "in": "path",
+            "required": true,
+            "schema": { "type": "string" }
+          }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "encrypted_value": {
+                    "type": "string",
+                    "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/enterprise-server@3.3/rest/reference/actions#get-an-organization-public-key) endpoint.",
+                    "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$"
+                  },
+                  "key_id": {
+                    "type": "string",
+                    "description": "ID of the key you used to encrypt the secret."
+                  },
+                  "visibility": {
+                    "type": "string",
+                    "description": "Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.",
+                    "enum": ["all", "private", "selected"]
+                  },
+                  "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/enterprise-server@3.3/rest/reference/actions#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.3/rest/reference/actions#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.3/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints.",
+                    "items": { "type": "integer" }
+                  }
+                },
+                "required": ["visibility"]
+              },
+              "examples": {
+                "default": {
+                  "value": {
+                    "encrypted_value": "c2VjcmV0",
+                    "key_id": "012345678912345678",
+                    "visibility": "selected",
+                    "selected_repository_ids": [1296269, 1296280]
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "201": {
+            "description": "Response when creating a secret",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "title": "Empty Object",
+                  "description": "An object without any properties.",
+                  "type": "object",
+                  "properties": {},
+                  "additionalProperties": false
+                },
+                "examples": { "default": { "value": null } }
+              }
+            }
+          },
+          "204": { "description": "Response when updating a secret" }
+        },
+        "x-github": {
+          "githubCloudOnly": false,
+          "enabledForGitHubApps": true,
+          "category": "actions",
+          "subcategory": "secrets"
+        },
+        "x-octokit": { "diff": { "ghes-3.4": { "type": "changed" } } }
+      }
+    },
     "/orgs/{org}/audit-log": {
       "get": {
         "summary": "Get the audit log for an organization",