@octokit/openapi 6.1.4 → 6.3.0

package/generated/github.ae-diff-to-api.github.com.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" },
@@ -2860,6 +2860,85 @@
         }
       }
     },
+    "/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/github-ae@latest/rest/reference/actions#create-or-update-an-organization-secret"
+        },
+        "parameters": [
+          { "$ref": "#/components/parameters/org" },
+          { "$ref": "#/components/parameters/secret-name" }
+        ],
+        "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/github-ae@latest/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/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": "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": { "$ref": "#/components/schemas/empty-object" },
+                "examples": { "default": { "value": null } }
+              }
+            }
+          },
+          "204": { "description": "Response when updating a secret" }
+        },
+        "x-github": {
+          "githubCloudOnly": false,
+          "enabledForGitHubApps": true,
+          "category": "actions",
+          "subcategory": "secrets"
+        },
+        "x-octokit": {
+          "diff": { "api.github.com.json": { "type": "changed" } }
+        }
+      }
+    },
     "/orgs/{org}/actions/secrets/{secret_name}/repositories": {
       "get": {
         "summary": "List selected repositories for an organization secret",
@@ -4168,6 +4247,160 @@
         }
       }
     },
+    "/repos/{owner}/{repo}/autolinks": {
+      "get": {
+        "summary": "List all autolinks of a repository",
+        "description": "This returns a list of autolinks configured for the given repository.\n\nInformation about autolinks are only available to repository administrators.",
+        "tags": ["repos"],
+        "operationId": "repos/list-autolinks",
+        "externalDocs": {
+          "description": "API method documentation",
+          "url": "https://docs.github.com/github-ae@latest/v3/repos#list-autolinks"
+        },
+        "parameters": [
+          { "$ref": "#/components/parameters/owner" },
+          { "$ref": "#/components/parameters/repo" },
+          { "$ref": "#/components/parameters/page" }
+        ],
+        "responses": {
+          "200": {
+            "description": "Response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "array",
+                  "items": { "$ref": "#/components/schemas/autolink" }
+                },
+                "examples": {
+                  "default": { "$ref": "#/components/examples/autolink-items" }
+                }
+              }
+            }
+          }
+        },
+        "x-github": {
+          "githubCloudOnly": false,
+          "enabledForGitHubApps": true,
+          "category": "repos",
+          "subcategory": "autolinks"
+        },
+        "x-octokit": {
+          "diff": { "api.github.com.json": { "type": "changed" } }
+        }
+      },
+      "post": {
+        "summary": "Create an autolink reference for a repository",
+        "description": "Users with admin access to the repository can create an autolink.",
+        "tags": ["repos"],
+        "operationId": "repos/create-autolink",
+        "externalDocs": {
+          "description": "API method documentation",
+          "url": "https://docs.github.com/github-ae@latest/v3/repos#create-an-autolink"
+        },
+        "parameters": [
+          { "$ref": "#/components/parameters/owner" },
+          { "$ref": "#/components/parameters/repo" }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "key_prefix": {
+                    "type": "string",
+                    "description": "The prefix appended by a number will generate a link any time it is found in an issue, pull request, or commit."
+                  },
+                  "url_template": {
+                    "type": "string",
+                    "description": "The URL must contain `<num>` for the reference number."
+                  }
+                },
+                "required": ["key_prefix", "url_template"]
+              },
+              "examples": {
+                "default": {
+                  "value": {
+                    "key_prefix": "TICKET-",
+                    "url_template": "https://example.com/TICKET?query=<num>"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "201": {
+            "description": "response",
+            "content": {
+              "application/json": {
+                "schema": { "$ref": "#/components/schemas/autolink" },
+                "examples": {
+                  "default": { "$ref": "#/components/examples/autolink" }
+                }
+              }
+            },
+            "headers": {
+              "Location": {
+                "example": "https://api.github.com/repos/octocat/Hello-World/autolinks/1",
+                "schema": { "type": "string" }
+              }
+            }
+          },
+          "422": { "$ref": "#/components/responses/validation_failed" }
+        },
+        "x-github": {
+          "githubCloudOnly": false,
+          "enabledForGitHubApps": true,
+          "category": "repos",
+          "subcategory": "autolinks"
+        },
+        "x-octokit": {
+          "diff": { "api.github.com.json": { "type": "changed" } }
+        }
+      }
+    },
+    "/repos/{owner}/{repo}/autolinks/{autolink_id}": {
+      "get": {
+        "summary": "Get an autolink reference of a repository",
+        "description": "This returns a single autolink reference by ID that was configured for the given repository.\n\nInformation about autolinks are only available to repository administrators.",
+        "tags": ["repos"],
+        "operationId": "repos/get-autolink",
+        "externalDocs": {
+          "description": "API method documentation",
+          "url": "https://docs.github.com/github-ae@latest/v3/repos#get-autolink"
+        },
+        "parameters": [
+          { "$ref": "#/components/parameters/owner" },
+          { "$ref": "#/components/parameters/repo" },
+          { "$ref": "#/components/parameters/autolink-id" }
+        ],
+        "responses": {
+          "200": {
+            "description": "Response",
+            "content": {
+              "application/json": {
+                "schema": { "$ref": "#/components/schemas/autolink" },
+                "examples": {
+                  "default": { "$ref": "#/components/examples/autolink" }
+                }
+              }
+            }
+          },
+          "404": { "$ref": "#/components/responses/not_found" }
+        },
+        "x-github": {
+          "githubCloudOnly": false,
+          "enabledForGitHubApps": true,
+          "category": "repos",
+          "subcategory": "autolinks"
+        },
+        "x-octokit": {
+          "diff": { "api.github.com.json": { "type": "changed" } }
+        }
+      }
+    },
     "/repos/{owner}/{repo}/check-suites": {
       "post": {
         "summary": "Create a check suite",
@@ -5010,6 +5243,11 @@
                 "schema": {
                   "type": "array",
                   "items": { "$ref": "#/components/schemas/event" }
+                },
+                "examples": {
+                  "200-response": {
+                    "$ref": "#/components/examples/repo-events-items"
+                  }
                 }
               }
             }
@@ -8477,6 +8715,13 @@
         "required": true,
         "schema": { "oneOf": [{ "type": "integer" }, { "type": "string" }] }
       },
+      "autolink-id": {
+        "name": "autolink_id",
+        "description": "The unique identifier of the autolink.",
+        "in": "path",
+        "required": true,
+        "schema": { "type": "integer" }
+      },
       "check-suite-id": {
         "name": "check_suite_id",
         "description": "The unique identifier of the check suite.",
@@ -10054,7 +10299,7 @@
             "$ref": "#/components/schemas/nullable-integration"
           },
           "author_association": {
-            "$ref": "#/components/schemas/author_association"
+            "$ref": "#/components/schemas/author-association"
           },
           "reactions": { "$ref": "#/components/schemas/reaction-rollup" }
         },
@@ -10217,6 +10462,13 @@
           "allows_public_repositories"
         ]
       },
+      "empty-object": {
+        "title": "Empty Object",
+        "description": "An object without any properties.",
+        "type": "object",
+        "properties": {},
+        "additionalProperties": false
+      },
       "minimal-repository": {
         "title": "Minimal Repository",
         "description": "Minimal Repository",
@@ -11471,7 +11723,7 @@
           "referenced_workflows": {
             "type": "array",
             "nullable": true,
-            "items": { "$ref": "#/components/schemas/referenced_workflow" }
+            "items": { "$ref": "#/components/schemas/referenced-workflow" }
           },
           "event": { "type": "string", "example": "push" },
           "status": {
@@ -11590,6 +11842,25 @@
           "pull_requests"
         ]
       },
+      "autolink": {
+        "title": "Autolink reference",
+        "description": "An autolink reference.",
+        "type": "object",
+        "properties": {
+          "id": { "type": "integer", "example": 3 },
+          "key_prefix": {
+            "description": "The prefix of a key that is linkified.",
+            "example": "TICKET-",
+            "type": "string"
+          },
+          "url_template": {
+            "description": "A template for the target URL that is generated if a key was found.",
+            "example": "https://example.com/TICKET?query=<num>",
+            "type": "string"
+          }
+        },
+        "required": ["id", "key_prefix", "url_template"]
+      },
       "check-suite": {
         "title": "CheckSuite",
         "description": "A suite of checks performed on the code of a given code change",
@@ -12202,9 +12473,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,
@@ -12377,7 +12648,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": {
@@ -12725,7 +12996,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" },
@@ -13377,7 +13648,7 @@
         ],
         "nullable": true
       },
-      "author_association": {
+      "author-association": {
         "title": "author_association",
         "type": "string",
         "example": "OWNER",
@@ -14052,7 +14323,7 @@
           }
         }
       },
-      "referenced_workflow": {
+      "referenced-workflow": {
         "title": "Referenced workflow",
         "description": "A workflow referenced/reused by the initial caller workflow",
         "type": "object",
@@ -14615,7 +14886,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",
@@ -14724,7 +14995,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"
@@ -14878,7 +15149,7 @@
             "$ref": "#/components/schemas/nullable-integration"
           },
           "author_association": {
-            "$ref": "#/components/schemas/author_association"
+            "$ref": "#/components/schemas/author-association"
           },
           "reactions": { "$ref": "#/components/schemas/reaction-rollup" }
         },
@@ -18861,6 +19132,22 @@
           }
         }
       },
+      "autolink-items": {
+        "value": [
+          {
+            "id": 1,
+            "key_prefix": "TICKET-",
+            "url_template": "https://example.com/TICKET?query=<num>"
+          }
+        ]
+      },
+      "autolink": {
+        "value": {
+          "id": 1,
+          "key_prefix": "TICKET-",
+          "url_template": "https://example.com/TICKET?query=<num>"
+        }
+      },
       "check-suite": {
         "value": {
           "id": 5,
@@ -20561,6 +20848,69 @@
           "url": "https://api.github.com/repos/octocat/Hello-World/6dcb09b5b57875f334f61aebed695e2e4193db5e/status"
         }
       },
+      "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": [
           {