From 5d9014dcd93b36b669d98f08bab28ef6e5953360 Mon Sep 17 00:00:00 2001 From: docubot <67483024+docubot@users.noreply.github.com> Date: Fri, 2 Jun 2023 13:04:27 -0400 Subject: [PATCH] Update OpenAPI Description (#37438) Co-authored-by: skedwards88 --- .../fpt-2022-11-28/server-to-server-rest.json | 30 + .../data/ghae/server-to-server-rest.json | 18 + .../server-to-server-rest.json | 36 + .../data/ghes-3.4/server-to-server-rest.json | 18 + .../data/ghes-3.5/server-to-server-rest.json | 18 + .../data/ghes-3.6/server-to-server-rest.json | 18 + .../data/ghes-3.7/server-to-server-rest.json | 18 + .../data/ghes-3.8/server-to-server-rest.json | 18 + src/github-apps/lib/config.json | 2 +- src/rest/data/fpt-2022-11-28/schema.json | 983 +++++++++++--- src/rest/data/ghae/schema.json | 117 +- src/rest/data/ghec-2022-11-28/schema.json | 1205 ++++++++++++++--- src/rest/data/ghes-3.4/schema.json | 127 +- src/rest/data/ghes-3.5/schema.json | 127 +- src/rest/data/ghes-3.6/schema.json | 127 +- src/rest/data/ghes-3.7/schema.json | 127 +- src/rest/data/ghes-3.8/schema.json | 127 +- src/rest/lib/config.json | 2 +- src/webhooks/lib/config.json | 2 +- 19 files changed, 2550 insertions(+), 570 deletions(-) diff --git a/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json b/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json index 604d651c79..6becb2690c 100644 --- a/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json +++ b/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json @@ -150,6 +150,12 @@ "verb": "get", "requestPath": "/orgs/{org}/actions/runners/downloads" }, + { + "slug": "create-configuration-for-a-just-in-time-runner-for-an-organization", + "subcategory": "self-hosted-runners", + "verb": "post", + "requestPath": "/orgs/{org}/actions/runners/generate-jitconfig" + }, { "slug": "create-a-registration-token-for-an-organization", "subcategory": "self-hosted-runners", @@ -480,6 +486,12 @@ "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/runners/downloads" }, + { + "slug": "create-configuration-for-a-just-in-time-runner-for-a-repository", + "subcategory": "self-hosted-runners", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/actions/runners/generate-jitconfig" + }, { "slug": "create-a-registration-token-for-a-repository", "subcategory": "self-hosted-runners", @@ -2634,6 +2646,24 @@ "verb": "post", "requestPath": "/orgs/{org}/{security_product}/{enablement}" }, + { + "slug": "list-organization-memberships-for-the-authenticated-user", + "subcategory": "members", + "verb": "get", + "requestPath": "/user/memberships/orgs" + }, + { + "slug": "get-an-organization-membership-for-the-authenticated-user", + "subcategory": "members", + "verb": "get", + "requestPath": "/user/memberships/orgs/{org}" + }, + { + "slug": "update-an-organization-membership-for-the-authenticated-user", + "subcategory": "members", + "verb": "patch", + "requestPath": "/user/memberships/orgs/{org}" + }, { "slug": "list-organizations-for-a-user", "subcategory": "orgs", diff --git a/src/github-apps/data/ghae/server-to-server-rest.json b/src/github-apps/data/ghae/server-to-server-rest.json index c94c3155ed..28163196ac 100644 --- a/src/github-apps/data/ghae/server-to-server-rest.json +++ b/src/github-apps/data/ghae/server-to-server-rest.json @@ -1718,6 +1718,24 @@ "verb": "delete", "requestPath": "/orgs/{org}/outside_collaborators/{username}" }, + { + "slug": "list-organization-memberships-for-the-authenticated-user", + "subcategory": "members", + "verb": "get", + "requestPath": "/user/memberships/orgs" + }, + { + "slug": "get-an-organization-membership-for-the-authenticated-user", + "subcategory": "members", + "verb": "get", + "requestPath": "/user/memberships/orgs/{org}" + }, + { + "slug": "update-an-organization-membership-for-the-authenticated-user", + "subcategory": "members", + "verb": "patch", + "requestPath": "/user/memberships/orgs/{org}" + }, { "slug": "list-organizations-for-a-user", "subcategory": "orgs", diff --git a/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json b/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json index 34f1637167..49eca450d8 100644 --- a/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json +++ b/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json @@ -1,5 +1,11 @@ { "actions": [ + { + "slug": "create-configuration-for-a-just-in-time-runner-for-an-enterprise", + "subcategory": "self-hosted-runners", + "verb": "post", + "requestPath": "/enterprises/{enterprise}/actions/runners/generate-jitconfig" + }, { "slug": "get-github-actions-cache-usage-for-an-organization", "subcategory": "cache", @@ -228,6 +234,12 @@ "verb": "get", "requestPath": "/orgs/{org}/actions/runners/downloads" }, + { + "slug": "create-configuration-for-a-just-in-time-runner-for-an-organization", + "subcategory": "self-hosted-runners", + "verb": "post", + "requestPath": "/orgs/{org}/actions/runners/generate-jitconfig" + }, { "slug": "create-a-registration-token-for-an-organization", "subcategory": "self-hosted-runners", @@ -558,6 +570,12 @@ "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/runners/downloads" }, + { + "slug": "create-configuration-for-a-just-in-time-runner-for-a-repository", + "subcategory": "self-hosted-runners", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/actions/runners/generate-jitconfig" + }, { "slug": "create-a-registration-token-for-a-repository", "subcategory": "self-hosted-runners", @@ -2830,6 +2848,24 @@ "verb": "post", "requestPath": "/orgs/{org}/{security_product}/{enablement}" }, + { + "slug": "list-organization-memberships-for-the-authenticated-user", + "subcategory": "members", + "verb": "get", + "requestPath": "/user/memberships/orgs" + }, + { + "slug": "get-an-organization-membership-for-the-authenticated-user", + "subcategory": "members", + "verb": "get", + "requestPath": "/user/memberships/orgs/{org}" + }, + { + "slug": "update-an-organization-membership-for-the-authenticated-user", + "subcategory": "members", + "verb": "patch", + "requestPath": "/user/memberships/orgs/{org}" + }, { "slug": "list-organizations-for-a-user", "subcategory": "orgs", diff --git a/src/github-apps/data/ghes-3.4/server-to-server-rest.json b/src/github-apps/data/ghes-3.4/server-to-server-rest.json index b1544ea0ab..b76b608764 100644 --- a/src/github-apps/data/ghes-3.4/server-to-server-rest.json +++ b/src/github-apps/data/ghes-3.4/server-to-server-rest.json @@ -2024,6 +2024,24 @@ "verb": "get", "requestPath": "/orgs/{org}/public_members/{username}" }, + { + "slug": "list-organization-memberships-for-the-authenticated-user", + "subcategory": "members", + "verb": "get", + "requestPath": "/user/memberships/orgs" + }, + { + "slug": "get-an-organization-membership-for-the-authenticated-user", + "subcategory": "members", + "verb": "get", + "requestPath": "/user/memberships/orgs/{org}" + }, + { + "slug": "update-an-organization-membership-for-the-authenticated-user", + "subcategory": "members", + "verb": "patch", + "requestPath": "/user/memberships/orgs/{org}" + }, { "slug": "list-organizations-for-a-user", "subcategory": "orgs", diff --git a/src/github-apps/data/ghes-3.5/server-to-server-rest.json b/src/github-apps/data/ghes-3.5/server-to-server-rest.json index e1680c903c..28f8985234 100644 --- a/src/github-apps/data/ghes-3.5/server-to-server-rest.json +++ b/src/github-apps/data/ghes-3.5/server-to-server-rest.json @@ -2114,6 +2114,24 @@ "verb": "get", "requestPath": "/orgs/{org}/public_members/{username}" }, + { + "slug": "list-organization-memberships-for-the-authenticated-user", + "subcategory": "members", + "verb": "get", + "requestPath": "/user/memberships/orgs" + }, + { + "slug": "get-an-organization-membership-for-the-authenticated-user", + "subcategory": "members", + "verb": "get", + "requestPath": "/user/memberships/orgs/{org}" + }, + { + "slug": "update-an-organization-membership-for-the-authenticated-user", + "subcategory": "members", + "verb": "patch", + "requestPath": "/user/memberships/orgs/{org}" + }, { "slug": "list-organizations-for-a-user", "subcategory": "orgs", diff --git a/src/github-apps/data/ghes-3.6/server-to-server-rest.json b/src/github-apps/data/ghes-3.6/server-to-server-rest.json index bbe0fad528..88bdce94df 100644 --- a/src/github-apps/data/ghes-3.6/server-to-server-rest.json +++ b/src/github-apps/data/ghes-3.6/server-to-server-rest.json @@ -2198,6 +2198,24 @@ "verb": "get", "requestPath": "/orgs/{org}/public_members/{username}" }, + { + "slug": "list-organization-memberships-for-the-authenticated-user", + "subcategory": "members", + "verb": "get", + "requestPath": "/user/memberships/orgs" + }, + { + "slug": "get-an-organization-membership-for-the-authenticated-user", + "subcategory": "members", + "verb": "get", + "requestPath": "/user/memberships/orgs/{org}" + }, + { + "slug": "update-an-organization-membership-for-the-authenticated-user", + "subcategory": "members", + "verb": "patch", + "requestPath": "/user/memberships/orgs/{org}" + }, { "slug": "list-organizations-for-a-user", "subcategory": "orgs", diff --git a/src/github-apps/data/ghes-3.7/server-to-server-rest.json b/src/github-apps/data/ghes-3.7/server-to-server-rest.json index 6a6f304129..b402fffb54 100644 --- a/src/github-apps/data/ghes-3.7/server-to-server-rest.json +++ b/src/github-apps/data/ghes-3.7/server-to-server-rest.json @@ -2272,6 +2272,24 @@ "verb": "post", "requestPath": "/orgs/{org}/{security_product}/{enablement}" }, + { + "slug": "list-organization-memberships-for-the-authenticated-user", + "subcategory": "members", + "verb": "get", + "requestPath": "/user/memberships/orgs" + }, + { + "slug": "get-an-organization-membership-for-the-authenticated-user", + "subcategory": "members", + "verb": "get", + "requestPath": "/user/memberships/orgs/{org}" + }, + { + "slug": "update-an-organization-membership-for-the-authenticated-user", + "subcategory": "members", + "verb": "patch", + "requestPath": "/user/memberships/orgs/{org}" + }, { "slug": "list-organizations-for-a-user", "subcategory": "orgs", diff --git a/src/github-apps/data/ghes-3.8/server-to-server-rest.json b/src/github-apps/data/ghes-3.8/server-to-server-rest.json index 96b563bd62..c8dace73eb 100644 --- a/src/github-apps/data/ghes-3.8/server-to-server-rest.json +++ b/src/github-apps/data/ghes-3.8/server-to-server-rest.json @@ -2502,6 +2502,24 @@ "verb": "post", "requestPath": "/orgs/{org}/{security_product}/{enablement}" }, + { + "slug": "list-organization-memberships-for-the-authenticated-user", + "subcategory": "members", + "verb": "get", + "requestPath": "/user/memberships/orgs" + }, + { + "slug": "get-an-organization-membership-for-the-authenticated-user", + "subcategory": "members", + "verb": "get", + "requestPath": "/user/memberships/orgs/{org}" + }, + { + "slug": "update-an-organization-membership-for-the-authenticated-user", + "subcategory": "members", + "verb": "patch", + "requestPath": "/user/memberships/orgs/{org}" + }, { "slug": "list-organizations-for-a-user", "subcategory": "orgs", diff --git a/src/github-apps/lib/config.json b/src/github-apps/lib/config.json index fbfbafb260..82c5e7ad09 100644 --- a/src/github-apps/lib/config.json +++ b/src/github-apps/lib/config.json @@ -7,5 +7,5 @@ "2022-11-28" ] }, - "sha": "df7d66cbf0ce6e08a1f4183278f91e2ea679684c" + "sha": "5c1ef48b46e09d15bbc945937e7990af6d99c64b" } \ No newline at end of file diff --git a/src/rest/data/fpt-2022-11-28/schema.json b/src/rest/data/fpt-2022-11-28/schema.json index 6d24d2b4d5..406f9edee0 100644 --- a/src/rest/data/fpt-2022-11-28/schema.json +++ b/src/rest/data/fpt-2022-11-28/schema.json @@ -13644,7 +13644,7 @@ "description": "

Response when updating a secret

" } ], - "descriptionHTML": "

Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. 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

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" + "descriptionHTML": "

Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. 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

*Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" }, { "serverUrl": "https://api.github.com", @@ -15445,7 +15445,7 @@ "description": "

Response when updating a secret

" } ], - "descriptionHTML": "

Creates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use\nthis endpoint.

\n

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" + "descriptionHTML": "

Creates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use\nthis endpoint.

\n

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" }, { "serverUrl": "https://api.github.com", @@ -15967,7 +15967,7 @@ "description": "

Response when updating a secret

" } ], - "descriptionHTML": "

Creates or updates an environment secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use\nthis endpoint.

\n

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" + "descriptionHTML": "

Creates or updates an environment secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use\nthis endpoint.

\n

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" }, { "serverUrl": "https://api.github.com", @@ -16368,6 +16368,228 @@ } ] }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/orgs/{org}/actions/runners/generate-jitconfig", + "title": "Create configuration for a just-in-time runner for an organization", + "category": "actions", + "subcategory": "self-hosted-runners", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "name", + "in": "body", + "description": "

The name of the new runner.

", + "isRequired": true + }, + { + "type": "integer", + "name": "runner_group_id", + "in": "body", + "description": "

The ID of the runner group to register the runner to.

", + "isRequired": true + }, + { + "type": "array of strings", + "name": "labels", + "in": "body", + "description": "

The names of the custom labels to add to the runner. Minimum items: 1. Maximum items: 100.

", + "isRequired": true + }, + { + "type": "string", + "name": "work_folder", + "in": "body", + "description": "

The working directory to be used for job execution, relative to the runner install directory.

", + "default": "_work" + } + ], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "New runner", + "runner_group_id": 1, + "labels": [ + "self-hosted", + "X64", + "macOS", + "no-gpu" + ], + "work_folder": "_work" + }, + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "

Response

", + "example": { + "runner": { + "id": 23, + "name": "New runner", + "os": "unknown", + "status": "offline", + "busy": false, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + }, + { + "id": 21, + "name": "no-gpu", + "type": "custom" + } + ] + }, + "encoded_jit_config": "abc123" + }, + "schema": { + "type": "object", + "required": [ + "runner", + "encoded_jit_config" + ], + "properties": { + "runner": { + "title": "Self hosted runners", + "description": "A self hosted runner", + "type": "object", + "properties": { + "id": { + "description": "The id of the runner.", + "type": "integer", + "examples": [ + 5 + ] + }, + "runner_group_id": { + "description": "The id of the runner group.", + "type": "integer", + "examples": [ + 1 + ] + }, + "name": { + "description": "The name of the runner.", + "type": "string", + "examples": [ + "iMac" + ] + }, + "os": { + "description": "The Operating System of the runner.", + "type": "string", + "examples": [ + "macos" + ] + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "examples": [ + "online" + ] + }, + "busy": { + "type": "boolean" + }, + "labels": { + "type": "array", + "items": { + "title": "Self hosted runner label", + "description": "A label for a self hosted runner", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the label." + }, + "name": { + "type": "string", + "description": "Name of the label." + }, + "type": { + "type": "string", + "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", + "enum": [ + "read-only", + "custom" + ] + } + }, + "required": [ + "name" + ] + } + } + }, + "required": [ + "id", + "name", + "os", + "status", + "busy", + "labels" + ] + }, + "encoded_jit_config": { + "type": "string", + "description": "The base64 encoded runner configuration." + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Generates a configuration that can be passed to the runner application at startup.

\n

You must authenticate using an access token with the admin:org scope to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "

Created

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ] + }, { "serverUrl": "https://api.github.com", "verb": "post", @@ -20769,6 +20991,238 @@ } ] }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/actions/runners/generate-jitconfig", + "title": "Create configuration for a just-in-time runner for a repository", + "category": "actions", + "subcategory": "self-hosted-runners", + "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" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "name", + "in": "body", + "description": "

The name of the new runner.

", + "isRequired": true + }, + { + "type": "integer", + "name": "runner_group_id", + "in": "body", + "description": "

The ID of the runner group to register the runner to.

", + "isRequired": true + }, + { + "type": "array of strings", + "name": "labels", + "in": "body", + "description": "

The names of the custom labels to add to the runner. Minimum items: 1. Maximum items: 100.

", + "isRequired": true + }, + { + "type": "string", + "name": "work_folder", + "in": "body", + "description": "

The working directory to be used for job execution, relative to the runner install directory.

", + "default": "_work" + } + ], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "New runner", + "runner_group_id": 1, + "labels": [ + "self-hosted", + "X64", + "macOS", + "no-gpu" + ], + "work_folder": "_work" + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "

Response

", + "example": { + "runner": { + "id": 23, + "name": "New runner", + "os": "unknown", + "status": "offline", + "busy": false, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + }, + { + "id": 21, + "name": "no-gpu", + "type": "custom" + } + ] + }, + "encoded_jit_config": "abc123" + }, + "schema": { + "type": "object", + "required": [ + "runner", + "encoded_jit_config" + ], + "properties": { + "runner": { + "title": "Self hosted runners", + "description": "A self hosted runner", + "type": "object", + "properties": { + "id": { + "description": "The id of the runner.", + "type": "integer", + "examples": [ + 5 + ] + }, + "runner_group_id": { + "description": "The id of the runner group.", + "type": "integer", + "examples": [ + 1 + ] + }, + "name": { + "description": "The name of the runner.", + "type": "string", + "examples": [ + "iMac" + ] + }, + "os": { + "description": "The Operating System of the runner.", + "type": "string", + "examples": [ + "macos" + ] + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "examples": [ + "online" + ] + }, + "busy": { + "type": "boolean" + }, + "labels": { + "type": "array", + "items": { + "title": "Self hosted runner label", + "description": "A label for a self hosted runner", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the label." + }, + "name": { + "type": "string", + "description": "Name of the label." + }, + "type": { + "type": "string", + "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", + "enum": [ + "read-only", + "custom" + ] + } + }, + "required": [ + "name" + ] + } + } + }, + "required": [ + "id", + "name", + "os", + "status", + "busy", + "labels" + ] + }, + "encoded_jit_config": { + "type": "string", + "description": "The base64 encoded runner configuration." + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Generates a configuration that can be passed to the runner application at startup.

\n

You must authenticate using an access token with the repo scope to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "

Created

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ] + }, { "serverUrl": "https://api.github.com", "verb": "post", @@ -111989,7 +112443,7 @@ } ], "previews": [], - "descriptionHTML": "

Remove a single repository from an installation. The authenticated user must have admin access to the repository.

\n

You must use a personal access token (which you can create via the command line or Basic Authentication) to access this endpoint.

", + "descriptionHTML": "

Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the repository_selection of selected.

\n

You must use a personal access token (which you can create via the command line or Basic Authentication) to access this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", @@ -112006,6 +112460,10 @@ { "httpStatusCode": "404", "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Returned when the application is installed on all repositories in the organization, or if this request would remove the last repository that the application has access to in the organization.

" } ] } @@ -193288,7 +193746,7 @@ "description": "

Validation failed, or the endpoint has been spammed.

" } ], - "descriptionHTML": "

Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the admin:org scope to use this endpoint.

\n

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" + "descriptionHTML": "

Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the admin:org scope to use this endpoint.

\n

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" }, { "serverUrl": "https://api.github.com", @@ -201620,7 +202078,7 @@ "description": "

Validation failed, or the endpoint has been spammed.

" } ], - "descriptionHTML": "

Creates or updates a secret for a user's codespace with an encrypted value. Encrypt your secret using\nLibSodium.

\n

You must authenticate using an access token with the codespace or codespace:secrets scope to use this endpoint. User must also have Codespaces access to use this endpoint.

\n

GitHub Apps must have write access to the codespaces_user_secrets user permission and codespaces_secrets repository permission on all referenced repositories to use this endpoint.

\n

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" + "descriptionHTML": "

Creates or updates a secret for a user's codespace with an encrypted value. Encrypt your secret using\nLibSodium.

\n

You must authenticate using an access token with the codespace or codespace:secrets scope to use this endpoint. User must also have Codespaces access to use this endpoint.

\n

GitHub Apps must have write access to the codespaces_user_secrets user permission and codespaces_secrets repository permission on all referenced repositories to use this endpoint.

\n

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" }, { "serverUrl": "https://api.github.com", @@ -230571,7 +231029,7 @@ "description": "

Response when updating a secret

" } ], - "descriptionHTML": "

Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization\npermission to use this endpoint.

\n

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" + "descriptionHTML": "

Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization\npermission to use this endpoint.

\n

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" }, { "serverUrl": "https://api.github.com", @@ -232217,7 +232675,7 @@ "description": "

Response when updating a secret

" } ], - "descriptionHTML": "

Creates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the repo scope to use this endpoint. GitHub Apps must have the dependabot_secrets repository\npermission to use this endpoint.

\n

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" + "descriptionHTML": "

Creates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the repo scope to use this endpoint. GitHub Apps must have the dependabot_secrets repository\npermission to use this endpoint.

\n

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" }, { "serverUrl": "https://api.github.com", @@ -275331,6 +275789,10 @@ "httpStatusCode": "201", "description": "

Created

" }, + { + "httpStatusCode": "400", + "description": "

Bad Request

" + }, { "httpStatusCode": "403", "description": "

Forbidden

" @@ -301704,8 +302166,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists events for a repository.

", "statusCodes": [ { "httpStatusCode": "200", @@ -306677,8 +307139,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Gets a single event by the event id.

", "statusCodes": [ { "httpStatusCode": "200", @@ -316824,8 +317286,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists all events for an issue.

", "statusCodes": [ { "httpStatusCode": "200", @@ -317003,8 +317465,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists all labels for an issue.

", "statusCodes": [ { "httpStatusCode": "200", @@ -317184,8 +317646,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Adds labels to an issue. If you provide an empty array of labels, all labels are removed from the issue.

", "statusCodes": [ { "httpStatusCode": "200", @@ -317450,8 +317912,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Removes all labels from an issue.

", "statusCodes": [ { "httpStatusCode": "204", @@ -317793,8 +318255,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists all labels for a repository.

", "statusCodes": [ { "httpStatusCode": "200", @@ -317954,8 +318416,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Creates a label for the specified repository with the given name and color. The name and color parameters are required. The color must be a valid hexadecimal color code.

", "statusCodes": [ { "httpStatusCode": "201", @@ -318103,8 +318565,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Gets a label using the given name.

", "statusCodes": [ { "httpStatusCode": "200", @@ -318273,8 +318735,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Updates a label using the given label name.

", "statusCodes": [ { "httpStatusCode": "200", @@ -318338,8 +318800,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Deletes a label using the given label name.

", "statusCodes": [ { "httpStatusCode": "204", @@ -318511,8 +318973,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists labels for issues in a milestone.

", "statusCodes": [ { "httpStatusCode": "200", @@ -318979,8 +319441,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists milestones for a repository.

", "statusCodes": [ { "httpStatusCode": "200", @@ -319421,8 +319883,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Creates a milestone.

", "statusCodes": [ { "httpStatusCode": "201", @@ -319839,8 +320301,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Gets a milestone using the given milestone number.

", "statusCodes": [ { "httpStatusCode": "200", @@ -320355,8 +320817,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Deletes a milestone using the given milestone number.

", "statusCodes": [ { "httpStatusCode": "204", @@ -336265,8 +336727,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

List all timeline events for an issue.

", "statusCodes": [ { "httpStatusCode": "200", @@ -337464,6 +337926,47 @@ "examples": [ "192.0.2.1" ] + }, + "domains": { + "type": "object", + "properties": { + "website": { + "type": "array", + "items": { + "type": "string", + "examples": [ + "example.com" + ] + } + }, + "codespaces": { + "type": "array", + "items": { + "type": "string", + "examples": [ + "example.com" + ] + } + }, + "copilot": { + "type": "array", + "items": { + "type": "string", + "examples": [ + "example.com" + ] + } + }, + "packages": { + "type": "array", + "items": { + "type": "string", + "examples": [ + "example.com" + ] + } + } + } } }, "required": [ @@ -362098,8 +362601,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Check if the provided user is a public member of the organization.

", "statusCodes": [ { "httpStatusCode": "204", @@ -362216,8 +362719,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default.

", "statusCodes": [ { "httpStatusCode": "204", @@ -362266,7 +362769,7 @@ } ], "bodyParameters": [], - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", @@ -362696,8 +363199,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists all of the authenticated user's organization memberships.

", "statusCodes": [ { "httpStatusCode": "200", @@ -362740,7 +363243,7 @@ } ], "bodyParameters": [], - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", @@ -363128,8 +363631,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

If the authenticated user is an active or pending member of the organization, this endpoint will return the user's membership. If the authenticated user is not affiliated with the organization, a 404 is returned. This endpoint will return a 403 if the request is made by a GitHub App that is blocked by the organization.

", "statusCodes": [ { "httpStatusCode": "200", @@ -363175,7 +363678,7 @@ ] } ], - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", @@ -363567,8 +364070,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Converts the authenticated user to an active member of the organization, if that user has a pending invitation from the organization.

", "statusCodes": [ { "httpStatusCode": "200", @@ -367310,6 +367813,24 @@ "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 + } } ], "bodyParameters": [], @@ -367334,14 +367855,18 @@ "name": "super cool ruleset", "source_type": "Organization", "source": "my-org", - "enforcement": "enabled" + "enforcement": "enabled", + "created_at": "2023-07-15T08:43:03Z", + "updated_at": "2023-08-23T16:29:47Z" }, { "id": 432, "name": "Another ruleset", "source_type": "Organization", "source": "my-org", - "enforcement": "enabled" + "enforcement": "enabled", + "created_at": "2023-08-15T08:43:03Z", + "updated_at": "2023-09-23T16:29:47Z" } ], "schema": { @@ -367545,7 +368070,7 @@ "oneOf": [ { "title": "creation", - "description": "Parameters to be used for the creation rule", + "description": "Only allow users with bypass permission to create matching refs.", "type": "object", "required": [ "type" @@ -367561,7 +368086,7 @@ }, { "title": "update", - "description": "Parameters to be used for the update rule", + "description": "Only allow users with bypass permission to update matching refs.", "type": "object", "required": [ "type" @@ -367589,7 +368114,7 @@ }, { "title": "deletion", - "description": "Parameters to be used for the deletion rule", + "description": "Only allow users with bypass permissions to delete matching refs.", "type": "object", "required": [ "type" @@ -367605,7 +368130,7 @@ }, { "title": "required_linear_history", - "description": "Parameters to be used for the required_linear_history rule", + "description": "Prevent merge commits from being pushed to matching branches.", "type": "object", "required": [ "type" @@ -367621,7 +368146,7 @@ }, { "title": "required_deployments", - "description": "Parameters to be used for the required_deployments rule", + "description": "Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.", "type": "object", "required": [ "type" @@ -367652,7 +368177,7 @@ }, { "title": "required_signatures", - "description": "Parameters to be used for the required_signatures rule", + "description": "Commits pushed to matching branches must have verified signatures.", "type": "object", "required": [ "type" @@ -367668,7 +368193,7 @@ }, { "title": "pull_request", - "description": "Parameters to be used for the pull_request rule", + "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", "type": "object", "required": [ "type" @@ -367718,7 +368243,7 @@ }, { "title": "required_status_checks", - "description": "Parameters to be used for the required_status_checks rule", + "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.", "type": "object", "required": [ "type" @@ -367769,7 +368294,7 @@ }, { "title": "non_fast_forward", - "description": "Parameters to be used for the non_fast_forward rule", + "description": "Prevent users with push access from force pushing to branches.", "type": "object", "required": [ "type" @@ -368020,6 +368545,14 @@ } ] } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" } } } @@ -368129,7 +368662,7 @@ { "type": "object", "name": "creation", - "description": "

Parameters to be used for the creation rule

", + "description": "

Only allow users with bypass permission to create matching refs.

", "isRequired": [ "type" ], @@ -368148,7 +368681,7 @@ { "type": "object", "name": "update", - "description": "

Parameters to be used for the update rule

", + "description": "

Only allow users with bypass permission to update matching refs.

", "isRequired": [ "type" ], @@ -368180,7 +368713,7 @@ { "type": "object", "name": "deletion", - "description": "

Parameters to be used for the deletion rule

", + "description": "

Only allow users with bypass permissions to delete matching refs.

", "isRequired": [ "type" ], @@ -368199,7 +368732,7 @@ { "type": "object", "name": "required_linear_history", - "description": "

Parameters to be used for the required_linear_history rule

", + "description": "

Prevent merge commits from being pushed to matching branches.

", "isRequired": [ "type" ], @@ -368218,7 +368751,7 @@ { "type": "object", "name": "required_deployments", - "description": "

Parameters to be used for the required_deployments rule

", + "description": "

Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.

", "isRequired": [ "type" ], @@ -368250,7 +368783,7 @@ { "type": "object", "name": "required_signatures", - "description": "

Parameters to be used for the required_signatures rule

", + "description": "

Commits pushed to matching branches must have verified signatures.

", "isRequired": [ "type" ], @@ -368269,7 +368802,7 @@ { "type": "object", "name": "pull_request", - "description": "

Parameters to be used for the pull_request rule

", + "description": "

Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.

", "isRequired": [ "type" ], @@ -368325,7 +368858,7 @@ { "type": "object", "name": "required_status_checks", - "description": "

Parameters to be used for the required_status_checks rule

", + "description": "

Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.

", "isRequired": [ "type" ], @@ -368376,7 +368909,7 @@ { "type": "object", "name": "non_fast_forward", - "description": "

Parameters to be used for the non_fast_forward rule

", + "description": "

Prevent users with push access from force pushing to branches.

", "isRequired": [ "type" ], @@ -368755,7 +369288,9 @@ "pattern": "github" } } - ] + ], + "created_at": "2023-08-15T08:43:03Z", + "updated_at": "2023-09-23T16:29:47Z" }, "schema": { "title": "Repository ruleset", @@ -368956,7 +369491,7 @@ "oneOf": [ { "title": "creation", - "description": "Parameters to be used for the creation rule", + "description": "Only allow users with bypass permission to create matching refs.", "type": "object", "required": [ "type" @@ -368972,7 +369507,7 @@ }, { "title": "update", - "description": "Parameters to be used for the update rule", + "description": "Only allow users with bypass permission to update matching refs.", "type": "object", "required": [ "type" @@ -369000,7 +369535,7 @@ }, { "title": "deletion", - "description": "Parameters to be used for the deletion rule", + "description": "Only allow users with bypass permissions to delete matching refs.", "type": "object", "required": [ "type" @@ -369016,7 +369551,7 @@ }, { "title": "required_linear_history", - "description": "Parameters to be used for the required_linear_history rule", + "description": "Prevent merge commits from being pushed to matching branches.", "type": "object", "required": [ "type" @@ -369032,7 +369567,7 @@ }, { "title": "required_deployments", - "description": "Parameters to be used for the required_deployments rule", + "description": "Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.", "type": "object", "required": [ "type" @@ -369063,7 +369598,7 @@ }, { "title": "required_signatures", - "description": "Parameters to be used for the required_signatures rule", + "description": "Commits pushed to matching branches must have verified signatures.", "type": "object", "required": [ "type" @@ -369079,7 +369614,7 @@ }, { "title": "pull_request", - "description": "Parameters to be used for the pull_request rule", + "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", "type": "object", "required": [ "type" @@ -369129,7 +369664,7 @@ }, { "title": "required_status_checks", - "description": "Parameters to be used for the required_status_checks rule", + "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.", "type": "object", "required": [ "type" @@ -369180,7 +369715,7 @@ }, { "title": "non_fast_forward", - "description": "Parameters to be used for the non_fast_forward rule", + "description": "Prevent users with push access from force pushing to branches.", "type": "object", "required": [ "type" @@ -369431,6 +369966,14 @@ } ] } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" } } } @@ -369540,7 +370083,9 @@ "pattern": "github" } } - ] + ], + "created_at": "2023-08-15T08:43:03Z", + "updated_at": "2023-09-23T16:29:47Z" }, "schema": { "title": "Repository ruleset", @@ -369741,7 +370286,7 @@ "oneOf": [ { "title": "creation", - "description": "Parameters to be used for the creation rule", + "description": "Only allow users with bypass permission to create matching refs.", "type": "object", "required": [ "type" @@ -369757,7 +370302,7 @@ }, { "title": "update", - "description": "Parameters to be used for the update rule", + "description": "Only allow users with bypass permission to update matching refs.", "type": "object", "required": [ "type" @@ -369785,7 +370330,7 @@ }, { "title": "deletion", - "description": "Parameters to be used for the deletion rule", + "description": "Only allow users with bypass permissions to delete matching refs.", "type": "object", "required": [ "type" @@ -369801,7 +370346,7 @@ }, { "title": "required_linear_history", - "description": "Parameters to be used for the required_linear_history rule", + "description": "Prevent merge commits from being pushed to matching branches.", "type": "object", "required": [ "type" @@ -369817,7 +370362,7 @@ }, { "title": "required_deployments", - "description": "Parameters to be used for the required_deployments rule", + "description": "Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.", "type": "object", "required": [ "type" @@ -369848,7 +370393,7 @@ }, { "title": "required_signatures", - "description": "Parameters to be used for the required_signatures rule", + "description": "Commits pushed to matching branches must have verified signatures.", "type": "object", "required": [ "type" @@ -369864,7 +370409,7 @@ }, { "title": "pull_request", - "description": "Parameters to be used for the pull_request rule", + "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", "type": "object", "required": [ "type" @@ -369914,7 +370459,7 @@ }, { "title": "required_status_checks", - "description": "Parameters to be used for the required_status_checks rule", + "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.", "type": "object", "required": [ "type" @@ -369965,7 +370510,7 @@ }, { "title": "non_fast_forward", - "description": "Parameters to be used for the non_fast_forward rule", + "description": "Prevent users with push access from force pushing to branches.", "type": "object", "required": [ "type" @@ -370216,6 +370761,14 @@ } ] } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" } } } @@ -370331,7 +370884,7 @@ { "type": "object", "name": "creation", - "description": "

Parameters to be used for the creation rule

", + "description": "

Only allow users with bypass permission to create matching refs.

", "isRequired": [ "type" ], @@ -370350,7 +370903,7 @@ { "type": "object", "name": "update", - "description": "

Parameters to be used for the update rule

", + "description": "

Only allow users with bypass permission to update matching refs.

", "isRequired": [ "type" ], @@ -370382,7 +370935,7 @@ { "type": "object", "name": "deletion", - "description": "

Parameters to be used for the deletion rule

", + "description": "

Only allow users with bypass permissions to delete matching refs.

", "isRequired": [ "type" ], @@ -370401,7 +370954,7 @@ { "type": "object", "name": "required_linear_history", - "description": "

Parameters to be used for the required_linear_history rule

", + "description": "

Prevent merge commits from being pushed to matching branches.

", "isRequired": [ "type" ], @@ -370420,7 +370973,7 @@ { "type": "object", "name": "required_deployments", - "description": "

Parameters to be used for the required_deployments rule

", + "description": "

Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.

", "isRequired": [ "type" ], @@ -370452,7 +371005,7 @@ { "type": "object", "name": "required_signatures", - "description": "

Parameters to be used for the required_signatures rule

", + "description": "

Commits pushed to matching branches must have verified signatures.

", "isRequired": [ "type" ], @@ -370471,7 +371024,7 @@ { "type": "object", "name": "pull_request", - "description": "

Parameters to be used for the pull_request rule

", + "description": "

Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.

", "isRequired": [ "type" ], @@ -370527,7 +371080,7 @@ { "type": "object", "name": "required_status_checks", - "description": "

Parameters to be used for the required_status_checks rule

", + "description": "

Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.

", "isRequired": [ "type" ], @@ -370578,7 +371131,7 @@ { "type": "object", "name": "non_fast_forward", - "description": "

Parameters to be used for the non_fast_forward rule

", + "description": "

Prevent users with push access from force pushing to branches.

", "isRequired": [ "type" ], @@ -370958,7 +371511,9 @@ "pattern": "github" } } - ] + ], + "created_at": "2023-08-15T08:43:03Z", + "updated_at": "2023-09-23T16:29:47Z" }, "schema": { "title": "Repository ruleset", @@ -371159,7 +371714,7 @@ "oneOf": [ { "title": "creation", - "description": "Parameters to be used for the creation rule", + "description": "Only allow users with bypass permission to create matching refs.", "type": "object", "required": [ "type" @@ -371175,7 +371730,7 @@ }, { "title": "update", - "description": "Parameters to be used for the update rule", + "description": "Only allow users with bypass permission to update matching refs.", "type": "object", "required": [ "type" @@ -371203,7 +371758,7 @@ }, { "title": "deletion", - "description": "Parameters to be used for the deletion rule", + "description": "Only allow users with bypass permissions to delete matching refs.", "type": "object", "required": [ "type" @@ -371219,7 +371774,7 @@ }, { "title": "required_linear_history", - "description": "Parameters to be used for the required_linear_history rule", + "description": "Prevent merge commits from being pushed to matching branches.", "type": "object", "required": [ "type" @@ -371235,7 +371790,7 @@ }, { "title": "required_deployments", - "description": "Parameters to be used for the required_deployments rule", + "description": "Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.", "type": "object", "required": [ "type" @@ -371266,7 +371821,7 @@ }, { "title": "required_signatures", - "description": "Parameters to be used for the required_signatures rule", + "description": "Commits pushed to matching branches must have verified signatures.", "type": "object", "required": [ "type" @@ -371282,7 +371837,7 @@ }, { "title": "pull_request", - "description": "Parameters to be used for the pull_request rule", + "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", "type": "object", "required": [ "type" @@ -371332,7 +371887,7 @@ }, { "title": "required_status_checks", - "description": "Parameters to be used for the required_status_checks rule", + "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.", "type": "object", "required": [ "type" @@ -371383,7 +371938,7 @@ }, { "title": "non_fast_forward", - "description": "Parameters to be used for the non_fast_forward rule", + "description": "Prevent users with push access from force pushing to branches.", "type": "object", "required": [ "type" @@ -371634,6 +372189,14 @@ } ] } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" } } } @@ -392890,8 +393453,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists projects for a user.

", "statusCodes": [ { "httpStatusCode": "200", @@ -393237,8 +393800,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Gets information about a project card.

", "statusCodes": [ { "httpStatusCode": "200", @@ -393676,8 +394239,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Deletes a project card

", "statusCodes": [ { "httpStatusCode": "204", @@ -394162,8 +394725,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists the project cards in a project.

", "statusCodes": [ { "httpStatusCode": "200", @@ -395426,8 +395989,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Gets information about a project column.

", "statusCodes": [ { "httpStatusCode": "200", @@ -395639,8 +396202,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Deletes a project column.

", "statusCodes": [ { "httpStatusCode": "204", @@ -395882,8 +396445,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists the project columns in a project.

", "statusCodes": [ { "httpStatusCode": "200", @@ -396034,8 +396597,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Creates a new project column.

", "statusCodes": [ { "httpStatusCode": "201", @@ -466247,12 +466810,16 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists the teams that have access to the specified repository and that are also visible to the authenticated user.

\n

For a public repository, a team is listed only if that team added the public repository explicitly.

\n

Personal access tokens require the following scopes:

\n\n

This endpoint is not compatible with fine-grained personal access tokens.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" } ] }, @@ -486538,6 +487105,24 @@ "type": "string" }, "x-multi-segment": true + }, + { + "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 + } } ], "bodyParameters": [], @@ -486583,7 +487168,7 @@ "oneOf": [ { "title": "creation", - "description": "Parameters to be used for the creation rule", + "description": "Only allow users with bypass permission to create matching refs.", "type": "object", "required": [ "type" @@ -486599,7 +487184,7 @@ }, { "title": "update", - "description": "Parameters to be used for the update rule", + "description": "Only allow users with bypass permission to update matching refs.", "type": "object", "required": [ "type" @@ -486627,7 +487212,7 @@ }, { "title": "deletion", - "description": "Parameters to be used for the deletion rule", + "description": "Only allow users with bypass permissions to delete matching refs.", "type": "object", "required": [ "type" @@ -486643,7 +487228,7 @@ }, { "title": "required_linear_history", - "description": "Parameters to be used for the required_linear_history rule", + "description": "Prevent merge commits from being pushed to matching branches.", "type": "object", "required": [ "type" @@ -486659,7 +487244,7 @@ }, { "title": "required_deployments", - "description": "Parameters to be used for the required_deployments rule", + "description": "Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.", "type": "object", "required": [ "type" @@ -486690,7 +487275,7 @@ }, { "title": "required_signatures", - "description": "Parameters to be used for the required_signatures rule", + "description": "Commits pushed to matching branches must have verified signatures.", "type": "object", "required": [ "type" @@ -486706,7 +487291,7 @@ }, { "title": "pull_request", - "description": "Parameters to be used for the pull_request rule", + "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", "type": "object", "required": [ "type" @@ -486756,7 +487341,7 @@ }, { "title": "required_status_checks", - "description": "Parameters to be used for the required_status_checks rule", + "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.", "type": "object", "required": [ "type" @@ -486807,7 +487392,7 @@ }, { "title": "non_fast_forward", - "description": "Parameters to be used for the non_fast_forward rule", + "description": "Prevent users with push access from force pushing to branches.", "type": "object", "required": [ "type" @@ -487097,6 +487682,24 @@ "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 + } + }, { "name": "includes_parents", "description": "

Include rulesets configured at higher levels that apply to this repository

", @@ -487130,14 +487733,18 @@ "name": "super cool ruleset", "source_type": "Repository", "source": "monalisa/my-repo", - "enforcement": "enabled" + "enforcement": "enabled", + "created_at": "2023-07-15T08:43:03Z", + "updated_at": "2023-08-23T16:29:47Z" }, { "id": 314, "name": "Another ruleset", "source_type": "Repository", "source": "monalisa/my-repo", - "enforcement": "enabled" + "enforcement": "enabled", + "created_at": "2023-08-15T08:43:03Z", + "updated_at": "2023-09-23T16:29:47Z" } ], "schema": { @@ -487341,7 +487948,7 @@ "oneOf": [ { "title": "creation", - "description": "Parameters to be used for the creation rule", + "description": "Only allow users with bypass permission to create matching refs.", "type": "object", "required": [ "type" @@ -487357,7 +487964,7 @@ }, { "title": "update", - "description": "Parameters to be used for the update rule", + "description": "Only allow users with bypass permission to update matching refs.", "type": "object", "required": [ "type" @@ -487385,7 +487992,7 @@ }, { "title": "deletion", - "description": "Parameters to be used for the deletion rule", + "description": "Only allow users with bypass permissions to delete matching refs.", "type": "object", "required": [ "type" @@ -487401,7 +488008,7 @@ }, { "title": "required_linear_history", - "description": "Parameters to be used for the required_linear_history rule", + "description": "Prevent merge commits from being pushed to matching branches.", "type": "object", "required": [ "type" @@ -487417,7 +488024,7 @@ }, { "title": "required_deployments", - "description": "Parameters to be used for the required_deployments rule", + "description": "Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.", "type": "object", "required": [ "type" @@ -487448,7 +488055,7 @@ }, { "title": "required_signatures", - "description": "Parameters to be used for the required_signatures rule", + "description": "Commits pushed to matching branches must have verified signatures.", "type": "object", "required": [ "type" @@ -487464,7 +488071,7 @@ }, { "title": "pull_request", - "description": "Parameters to be used for the pull_request rule", + "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", "type": "object", "required": [ "type" @@ -487514,7 +488121,7 @@ }, { "title": "required_status_checks", - "description": "Parameters to be used for the required_status_checks rule", + "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.", "type": "object", "required": [ "type" @@ -487565,7 +488172,7 @@ }, { "title": "non_fast_forward", - "description": "Parameters to be used for the non_fast_forward rule", + "description": "Prevent users with push access from force pushing to branches.", "type": "object", "required": [ "type" @@ -487816,6 +488423,14 @@ } ] } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" } } } @@ -487964,7 +488579,7 @@ { "type": "object", "name": "creation", - "description": "

Parameters to be used for the creation rule

", + "description": "

Only allow users with bypass permission to create matching refs.

", "isRequired": [ "type" ], @@ -487983,7 +488598,7 @@ { "type": "object", "name": "update", - "description": "

Parameters to be used for the update rule

", + "description": "

Only allow users with bypass permission to update matching refs.

", "isRequired": [ "type" ], @@ -488015,7 +488630,7 @@ { "type": "object", "name": "deletion", - "description": "

Parameters to be used for the deletion rule

", + "description": "

Only allow users with bypass permissions to delete matching refs.

", "isRequired": [ "type" ], @@ -488034,7 +488649,7 @@ { "type": "object", "name": "required_linear_history", - "description": "

Parameters to be used for the required_linear_history rule

", + "description": "

Prevent merge commits from being pushed to matching branches.

", "isRequired": [ "type" ], @@ -488053,7 +488668,7 @@ { "type": "object", "name": "required_deployments", - "description": "

Parameters to be used for the required_deployments rule

", + "description": "

Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.

", "isRequired": [ "type" ], @@ -488085,7 +488700,7 @@ { "type": "object", "name": "required_signatures", - "description": "

Parameters to be used for the required_signatures rule

", + "description": "

Commits pushed to matching branches must have verified signatures.

", "isRequired": [ "type" ], @@ -488104,7 +488719,7 @@ { "type": "object", "name": "pull_request", - "description": "

Parameters to be used for the pull_request rule

", + "description": "

Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.

", "isRequired": [ "type" ], @@ -488160,7 +488775,7 @@ { "type": "object", "name": "required_status_checks", - "description": "

Parameters to be used for the required_status_checks rule

", + "description": "

Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.

", "isRequired": [ "type" ], @@ -488211,7 +488826,7 @@ { "type": "object", "name": "non_fast_forward", - "description": "

Parameters to be used for the non_fast_forward rule

", + "description": "

Prevent users with push access from force pushing to branches.

", "isRequired": [ "type" ], @@ -488583,7 +489198,9 @@ "pattern": "github" } } - ] + ], + "created_at": "2023-07-15T08:43:03Z", + "updated_at": "2023-08-23T16:29:47Z" }, "schema": { "title": "Repository ruleset", @@ -488784,7 +489401,7 @@ "oneOf": [ { "title": "creation", - "description": "Parameters to be used for the creation rule", + "description": "Only allow users with bypass permission to create matching refs.", "type": "object", "required": [ "type" @@ -488800,7 +489417,7 @@ }, { "title": "update", - "description": "Parameters to be used for the update rule", + "description": "Only allow users with bypass permission to update matching refs.", "type": "object", "required": [ "type" @@ -488828,7 +489445,7 @@ }, { "title": "deletion", - "description": "Parameters to be used for the deletion rule", + "description": "Only allow users with bypass permissions to delete matching refs.", "type": "object", "required": [ "type" @@ -488844,7 +489461,7 @@ }, { "title": "required_linear_history", - "description": "Parameters to be used for the required_linear_history rule", + "description": "Prevent merge commits from being pushed to matching branches.", "type": "object", "required": [ "type" @@ -488860,7 +489477,7 @@ }, { "title": "required_deployments", - "description": "Parameters to be used for the required_deployments rule", + "description": "Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.", "type": "object", "required": [ "type" @@ -488891,7 +489508,7 @@ }, { "title": "required_signatures", - "description": "Parameters to be used for the required_signatures rule", + "description": "Commits pushed to matching branches must have verified signatures.", "type": "object", "required": [ "type" @@ -488907,7 +489524,7 @@ }, { "title": "pull_request", - "description": "Parameters to be used for the pull_request rule", + "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", "type": "object", "required": [ "type" @@ -488957,7 +489574,7 @@ }, { "title": "required_status_checks", - "description": "Parameters to be used for the required_status_checks rule", + "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.", "type": "object", "required": [ "type" @@ -489008,7 +489625,7 @@ }, { "title": "non_fast_forward", - "description": "Parameters to be used for the non_fast_forward rule", + "description": "Prevent users with push access from force pushing to branches.", "type": "object", "required": [ "type" @@ -489259,6 +489876,14 @@ } ] } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" } } } @@ -489378,7 +490003,9 @@ "pattern": "github" } } - ] + ], + "created_at": "2023-07-15T08:43:03Z", + "updated_at": "2023-08-23T16:29:47Z" }, "schema": { "title": "Repository ruleset", @@ -489579,7 +490206,7 @@ "oneOf": [ { "title": "creation", - "description": "Parameters to be used for the creation rule", + "description": "Only allow users with bypass permission to create matching refs.", "type": "object", "required": [ "type" @@ -489595,7 +490222,7 @@ }, { "title": "update", - "description": "Parameters to be used for the update rule", + "description": "Only allow users with bypass permission to update matching refs.", "type": "object", "required": [ "type" @@ -489623,7 +490250,7 @@ }, { "title": "deletion", - "description": "Parameters to be used for the deletion rule", + "description": "Only allow users with bypass permissions to delete matching refs.", "type": "object", "required": [ "type" @@ -489639,7 +490266,7 @@ }, { "title": "required_linear_history", - "description": "Parameters to be used for the required_linear_history rule", + "description": "Prevent merge commits from being pushed to matching branches.", "type": "object", "required": [ "type" @@ -489655,7 +490282,7 @@ }, { "title": "required_deployments", - "description": "Parameters to be used for the required_deployments rule", + "description": "Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.", "type": "object", "required": [ "type" @@ -489686,7 +490313,7 @@ }, { "title": "required_signatures", - "description": "Parameters to be used for the required_signatures rule", + "description": "Commits pushed to matching branches must have verified signatures.", "type": "object", "required": [ "type" @@ -489702,7 +490329,7 @@ }, { "title": "pull_request", - "description": "Parameters to be used for the pull_request rule", + "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", "type": "object", "required": [ "type" @@ -489752,7 +490379,7 @@ }, { "title": "required_status_checks", - "description": "Parameters to be used for the required_status_checks rule", + "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.", "type": "object", "required": [ "type" @@ -489803,7 +490430,7 @@ }, { "title": "non_fast_forward", - "description": "Parameters to be used for the non_fast_forward rule", + "description": "Prevent users with push access from force pushing to branches.", "type": "object", "required": [ "type" @@ -490054,6 +490681,14 @@ } ] } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" } } } @@ -490208,7 +490843,7 @@ { "type": "object", "name": "creation", - "description": "

Parameters to be used for the creation rule

", + "description": "

Only allow users with bypass permission to create matching refs.

", "isRequired": [ "type" ], @@ -490227,7 +490862,7 @@ { "type": "object", "name": "update", - "description": "

Parameters to be used for the update rule

", + "description": "

Only allow users with bypass permission to update matching refs.

", "isRequired": [ "type" ], @@ -490259,7 +490894,7 @@ { "type": "object", "name": "deletion", - "description": "

Parameters to be used for the deletion rule

", + "description": "

Only allow users with bypass permissions to delete matching refs.

", "isRequired": [ "type" ], @@ -490278,7 +490913,7 @@ { "type": "object", "name": "required_linear_history", - "description": "

Parameters to be used for the required_linear_history rule

", + "description": "

Prevent merge commits from being pushed to matching branches.

", "isRequired": [ "type" ], @@ -490297,7 +490932,7 @@ { "type": "object", "name": "required_deployments", - "description": "

Parameters to be used for the required_deployments rule

", + "description": "

Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.

", "isRequired": [ "type" ], @@ -490329,7 +490964,7 @@ { "type": "object", "name": "required_signatures", - "description": "

Parameters to be used for the required_signatures rule

", + "description": "

Commits pushed to matching branches must have verified signatures.

", "isRequired": [ "type" ], @@ -490348,7 +490983,7 @@ { "type": "object", "name": "pull_request", - "description": "

Parameters to be used for the pull_request rule

", + "description": "

Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.

", "isRequired": [ "type" ], @@ -490404,7 +491039,7 @@ { "type": "object", "name": "required_status_checks", - "description": "

Parameters to be used for the required_status_checks rule

", + "description": "

Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.

", "isRequired": [ "type" ], @@ -490455,7 +491090,7 @@ { "type": "object", "name": "non_fast_forward", - "description": "

Parameters to be used for the non_fast_forward rule

", + "description": "

Prevent users with push access from force pushing to branches.

", "isRequired": [ "type" ], @@ -490828,7 +491463,9 @@ "pattern": "github" } } - ] + ], + "created_at": "2023-07-15T08:43:03Z", + "updated_at": "2023-08-23T16:29:47Z" }, "schema": { "title": "Repository ruleset", @@ -491029,7 +491666,7 @@ "oneOf": [ { "title": "creation", - "description": "Parameters to be used for the creation rule", + "description": "Only allow users with bypass permission to create matching refs.", "type": "object", "required": [ "type" @@ -491045,7 +491682,7 @@ }, { "title": "update", - "description": "Parameters to be used for the update rule", + "description": "Only allow users with bypass permission to update matching refs.", "type": "object", "required": [ "type" @@ -491073,7 +491710,7 @@ }, { "title": "deletion", - "description": "Parameters to be used for the deletion rule", + "description": "Only allow users with bypass permissions to delete matching refs.", "type": "object", "required": [ "type" @@ -491089,7 +491726,7 @@ }, { "title": "required_linear_history", - "description": "Parameters to be used for the required_linear_history rule", + "description": "Prevent merge commits from being pushed to matching branches.", "type": "object", "required": [ "type" @@ -491105,7 +491742,7 @@ }, { "title": "required_deployments", - "description": "Parameters to be used for the required_deployments rule", + "description": "Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.", "type": "object", "required": [ "type" @@ -491136,7 +491773,7 @@ }, { "title": "required_signatures", - "description": "Parameters to be used for the required_signatures rule", + "description": "Commits pushed to matching branches must have verified signatures.", "type": "object", "required": [ "type" @@ -491152,7 +491789,7 @@ }, { "title": "pull_request", - "description": "Parameters to be used for the pull_request rule", + "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", "type": "object", "required": [ "type" @@ -491202,7 +491839,7 @@ }, { "title": "required_status_checks", - "description": "Parameters to be used for the required_status_checks rule", + "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.", "type": "object", "required": [ "type" @@ -491253,7 +491890,7 @@ }, { "title": "non_fast_forward", - "description": "Parameters to be used for the non_fast_forward rule", + "description": "Prevent users with push access from force pushing to branches.", "type": "object", "required": [ "type" @@ -491504,6 +492141,14 @@ } ] } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" } } } diff --git a/src/rest/data/ghae/schema.json b/src/rest/data/ghae/schema.json index ae35d67fa7..0d547b599a 100644 --- a/src/rest/data/ghae/schema.json +++ b/src/rest/data/ghae/schema.json @@ -4563,7 +4563,7 @@ "description": "

Response when updating a secret

" } ], - "descriptionHTML": "

Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. 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

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" + "descriptionHTML": "

Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. 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

*Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" }, { "serverUrl": "https://HOSTNAME/api/v3", @@ -6364,7 +6364,7 @@ "description": "

Response when updating a secret

" } ], - "descriptionHTML": "

Creates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use\nthis endpoint.

\n

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" + "descriptionHTML": "

Creates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use\nthis endpoint.

\n

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" }, { "serverUrl": "https://HOSTNAME/api/v3", @@ -183703,6 +183703,10 @@ "httpStatusCode": "201", "description": "

Created

" }, + { + "httpStatusCode": "400", + "description": "

Bad Request

" + }, { "httpStatusCode": "403", "description": "

Forbidden

" @@ -209566,8 +209570,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists events for a repository.

", "statusCodes": [ { "httpStatusCode": "200", @@ -214454,8 +214458,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Gets a single event by the event id.

", "statusCodes": [ { "httpStatusCode": "200", @@ -224601,8 +224605,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists all events for an issue.

", "statusCodes": [ { "httpStatusCode": "200", @@ -224780,8 +224784,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists all labels for an issue.

", "statusCodes": [ { "httpStatusCode": "200", @@ -224961,8 +224965,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Adds labels to an issue. If you provide an empty array of labels, all labels are removed from the issue.

", "statusCodes": [ { "httpStatusCode": "200", @@ -225227,8 +225231,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Removes all labels from an issue.

", "statusCodes": [ { "httpStatusCode": "204", @@ -225570,8 +225574,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists all labels for a repository.

", "statusCodes": [ { "httpStatusCode": "200", @@ -225731,8 +225735,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Creates a label for the specified repository with the given name and color. The name and color parameters are required. The color must be a valid hexadecimal color code.

", "statusCodes": [ { "httpStatusCode": "201", @@ -225880,8 +225884,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Gets a label using the given name.

", "statusCodes": [ { "httpStatusCode": "200", @@ -226050,8 +226054,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Updates a label using the given label name.

", "statusCodes": [ { "httpStatusCode": "200", @@ -226115,8 +226119,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Deletes a label using the given label name.

", "statusCodes": [ { "httpStatusCode": "204", @@ -226288,8 +226292,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists labels for issues in a milestone.

", "statusCodes": [ { "httpStatusCode": "200", @@ -226756,8 +226760,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists milestones for a repository.

", "statusCodes": [ { "httpStatusCode": "200", @@ -227198,8 +227202,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Creates a milestone.

", "statusCodes": [ { "httpStatusCode": "201", @@ -227616,8 +227620,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Gets a milestone using the given milestone number.

", "statusCodes": [ { "httpStatusCode": "200", @@ -228132,8 +228136,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Deletes a milestone using the given milestone number.

", "statusCodes": [ { "httpStatusCode": "204", @@ -243957,8 +243961,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

List all timeline events for an issue.

", "statusCodes": [ { "httpStatusCode": "200", @@ -245142,6 +245146,47 @@ "examples": [ "192.0.2.1" ] + }, + "domains": { + "type": "object", + "properties": { + "website": { + "type": "array", + "items": { + "type": "string", + "examples": [ + "example.com" + ] + } + }, + "codespaces": { + "type": "array", + "items": { + "type": "string", + "examples": [ + "example.com" + ] + } + }, + "copilot": { + "type": "array", + "items": { + "type": "string", + "examples": [ + "example.com" + ] + } + }, + "packages": { + "type": "array", + "items": { + "type": "string", + "examples": [ + "example.com" + ] + } + } + } } }, "required": [ @@ -262406,7 +262451,7 @@ } ], "bodyParameters": [], - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", @@ -262836,8 +262881,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists all of the authenticated user's organization memberships.

", "statusCodes": [ { "httpStatusCode": "200", @@ -262880,7 +262925,7 @@ } ], "bodyParameters": [], - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", @@ -263268,8 +263313,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

If the authenticated user is an active or pending member of the organization, this endpoint will return the user's membership. If the authenticated user is not affiliated with the organization, a 404 is returned. This endpoint will return a 403 if the request is made by a GitHub App that is blocked by the organization.

", "statusCodes": [ { "httpStatusCode": "200", @@ -263315,7 +263360,7 @@ ] } ], - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", @@ -263707,8 +263752,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Converts the authenticated user to an active member of the organization, if that user has a pending invitation from the organization.

", "statusCodes": [ { "httpStatusCode": "200", @@ -271177,8 +271222,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists projects for a user.

", "statusCodes": [ { "httpStatusCode": "200", @@ -271524,8 +271569,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Gets information about a project card.

", "statusCodes": [ { "httpStatusCode": "200", @@ -271963,8 +272008,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Deletes a project card

", "statusCodes": [ { "httpStatusCode": "204", @@ -272449,8 +272494,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists the project cards in a project.

", "statusCodes": [ { "httpStatusCode": "200", @@ -273713,8 +273758,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Gets information about a project column.

", "statusCodes": [ { "httpStatusCode": "200", @@ -273926,8 +273971,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Deletes a project column.

", "statusCodes": [ { "httpStatusCode": "204", @@ -274169,8 +274214,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists the project columns in a project.

", "statusCodes": [ { "httpStatusCode": "200", @@ -274321,8 +274366,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Creates a new project column.

", "statusCodes": [ { "httpStatusCode": "201", @@ -341719,12 +341764,16 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists the teams that have access to the specified repository and that are also visible to the authenticated user.

\n

For a public repository, a team is listed only if that team added the public repository explicitly.

\n

Personal access tokens require the following scopes:

\n\n

This endpoint is not compatible with fine-grained personal access tokens.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" } ] }, diff --git a/src/rest/data/ghec-2022-11-28/schema.json b/src/rest/data/ghec-2022-11-28/schema.json index f8361196c5..07a9497103 100644 --- a/src/rest/data/ghec-2022-11-28/schema.json +++ b/src/rest/data/ghec-2022-11-28/schema.json @@ -14584,7 +14584,7 @@ "description": "

Response when updating a secret

" } ], - "descriptionHTML": "

Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. 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

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" + "descriptionHTML": "

Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. 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

*Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" }, { "serverUrl": "https://api.github.com", @@ -16385,7 +16385,7 @@ "description": "

Response when updating a secret

" } ], - "descriptionHTML": "

Creates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use\nthis endpoint.

\n

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" + "descriptionHTML": "

Creates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use\nthis endpoint.

\n

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" }, { "serverUrl": "https://api.github.com", @@ -16907,7 +16907,7 @@ "description": "

Response when updating a secret

" } ], - "descriptionHTML": "

Creates or updates an environment secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use\nthis endpoint.

\n

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" + "descriptionHTML": "

Creates or updates an environment secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use\nthis endpoint.

\n

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" }, { "serverUrl": "https://api.github.com", @@ -21361,6 +21361,228 @@ } ] }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/enterprises/{enterprise}/actions/runners/generate-jitconfig", + "title": "Create configuration for a just-in-time runner for an Enterprise", + "category": "actions", + "subcategory": "self-hosted-runners", + "parameters": [ + { + "name": "enterprise", + "description": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "name", + "in": "body", + "description": "

The name of the new runner.

", + "isRequired": true + }, + { + "type": "integer", + "name": "runner_group_id", + "in": "body", + "description": "

The ID of the runner group to register the runner to.

", + "isRequired": true + }, + { + "type": "array of strings", + "name": "labels", + "in": "body", + "description": "

The names of the custom labels to add to the runner. Minimum items: 1. Maximum items: 100.

", + "isRequired": true + }, + { + "type": "string", + "name": "work_folder", + "in": "body", + "description": "

The working directory to be used for job execution, relative to the runner install directory.

", + "default": "_work" + } + ], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "New runner", + "runner_group_id": 1, + "labels": [ + "self-hosted", + "X64", + "macOS", + "no-gpu" + ], + "work_folder": "_work" + }, + "parameters": { + "enterprise": "ENTERPRISE" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "

Response

", + "example": { + "runner": { + "id": 23, + "name": "New runner", + "os": "unknown", + "status": "offline", + "busy": false, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + }, + { + "id": 21, + "name": "no-gpu", + "type": "custom" + } + ] + }, + "encoded_jit_config": "abc123" + }, + "schema": { + "type": "object", + "required": [ + "runner", + "encoded_jit_config" + ], + "properties": { + "runner": { + "title": "Self hosted runners", + "description": "A self hosted runner", + "type": "object", + "properties": { + "id": { + "description": "The id of the runner.", + "type": "integer", + "examples": [ + 5 + ] + }, + "runner_group_id": { + "description": "The id of the runner group.", + "type": "integer", + "examples": [ + 1 + ] + }, + "name": { + "description": "The name of the runner.", + "type": "string", + "examples": [ + "iMac" + ] + }, + "os": { + "description": "The Operating System of the runner.", + "type": "string", + "examples": [ + "macos" + ] + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "examples": [ + "online" + ] + }, + "busy": { + "type": "boolean" + }, + "labels": { + "type": "array", + "items": { + "title": "Self hosted runner label", + "description": "A label for a self hosted runner", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the label." + }, + "name": { + "type": "string", + "description": "Name of the label." + }, + "type": { + "type": "string", + "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", + "enum": [ + "read-only", + "custom" + ] + } + }, + "required": [ + "name" + ] + } + } + }, + "required": [ + "id", + "name", + "os", + "status", + "busy", + "labels" + ] + }, + "encoded_jit_config": { + "type": "string", + "description": "The base64 encoded runner configuration." + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Generates a configuration that can be passed to the runner application at startup.

\n

You must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "

Created

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ] + }, { "serverUrl": "https://api.github.com", "verb": "post", @@ -25746,6 +25968,228 @@ } ] }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/orgs/{org}/actions/runners/generate-jitconfig", + "title": "Create configuration for a just-in-time runner for an organization", + "category": "actions", + "subcategory": "self-hosted-runners", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "name", + "in": "body", + "description": "

The name of the new runner.

", + "isRequired": true + }, + { + "type": "integer", + "name": "runner_group_id", + "in": "body", + "description": "

The ID of the runner group to register the runner to.

", + "isRequired": true + }, + { + "type": "array of strings", + "name": "labels", + "in": "body", + "description": "

The names of the custom labels to add to the runner. Minimum items: 1. Maximum items: 100.

", + "isRequired": true + }, + { + "type": "string", + "name": "work_folder", + "in": "body", + "description": "

The working directory to be used for job execution, relative to the runner install directory.

", + "default": "_work" + } + ], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "New runner", + "runner_group_id": 1, + "labels": [ + "self-hosted", + "X64", + "macOS", + "no-gpu" + ], + "work_folder": "_work" + }, + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "

Response

", + "example": { + "runner": { + "id": 23, + "name": "New runner", + "os": "unknown", + "status": "offline", + "busy": false, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + }, + { + "id": 21, + "name": "no-gpu", + "type": "custom" + } + ] + }, + "encoded_jit_config": "abc123" + }, + "schema": { + "type": "object", + "required": [ + "runner", + "encoded_jit_config" + ], + "properties": { + "runner": { + "title": "Self hosted runners", + "description": "A self hosted runner", + "type": "object", + "properties": { + "id": { + "description": "The id of the runner.", + "type": "integer", + "examples": [ + 5 + ] + }, + "runner_group_id": { + "description": "The id of the runner group.", + "type": "integer", + "examples": [ + 1 + ] + }, + "name": { + "description": "The name of the runner.", + "type": "string", + "examples": [ + "iMac" + ] + }, + "os": { + "description": "The Operating System of the runner.", + "type": "string", + "examples": [ + "macos" + ] + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "examples": [ + "online" + ] + }, + "busy": { + "type": "boolean" + }, + "labels": { + "type": "array", + "items": { + "title": "Self hosted runner label", + "description": "A label for a self hosted runner", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the label." + }, + "name": { + "type": "string", + "description": "Name of the label." + }, + "type": { + "type": "string", + "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", + "enum": [ + "read-only", + "custom" + ] + } + }, + "required": [ + "name" + ] + } + } + }, + "required": [ + "id", + "name", + "os", + "status", + "busy", + "labels" + ] + }, + "encoded_jit_config": { + "type": "string", + "description": "The base64 encoded runner configuration." + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Generates a configuration that can be passed to the runner application at startup.

\n

You must authenticate using an access token with the admin:org scope to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "

Created

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ] + }, { "serverUrl": "https://api.github.com", "verb": "post", @@ -30147,6 +30591,238 @@ } ] }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/actions/runners/generate-jitconfig", + "title": "Create configuration for a just-in-time runner for a repository", + "category": "actions", + "subcategory": "self-hosted-runners", + "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" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "name", + "in": "body", + "description": "

The name of the new runner.

", + "isRequired": true + }, + { + "type": "integer", + "name": "runner_group_id", + "in": "body", + "description": "

The ID of the runner group to register the runner to.

", + "isRequired": true + }, + { + "type": "array of strings", + "name": "labels", + "in": "body", + "description": "

The names of the custom labels to add to the runner. Minimum items: 1. Maximum items: 100.

", + "isRequired": true + }, + { + "type": "string", + "name": "work_folder", + "in": "body", + "description": "

The working directory to be used for job execution, relative to the runner install directory.

", + "default": "_work" + } + ], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "New runner", + "runner_group_id": 1, + "labels": [ + "self-hosted", + "X64", + "macOS", + "no-gpu" + ], + "work_folder": "_work" + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "

Response

", + "example": { + "runner": { + "id": 23, + "name": "New runner", + "os": "unknown", + "status": "offline", + "busy": false, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + }, + { + "id": 21, + "name": "no-gpu", + "type": "custom" + } + ] + }, + "encoded_jit_config": "abc123" + }, + "schema": { + "type": "object", + "required": [ + "runner", + "encoded_jit_config" + ], + "properties": { + "runner": { + "title": "Self hosted runners", + "description": "A self hosted runner", + "type": "object", + "properties": { + "id": { + "description": "The id of the runner.", + "type": "integer", + "examples": [ + 5 + ] + }, + "runner_group_id": { + "description": "The id of the runner group.", + "type": "integer", + "examples": [ + 1 + ] + }, + "name": { + "description": "The name of the runner.", + "type": "string", + "examples": [ + "iMac" + ] + }, + "os": { + "description": "The Operating System of the runner.", + "type": "string", + "examples": [ + "macos" + ] + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "examples": [ + "online" + ] + }, + "busy": { + "type": "boolean" + }, + "labels": { + "type": "array", + "items": { + "title": "Self hosted runner label", + "description": "A label for a self hosted runner", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the label." + }, + "name": { + "type": "string", + "description": "Name of the label." + }, + "type": { + "type": "string", + "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", + "enum": [ + "read-only", + "custom" + ] + } + }, + "required": [ + "name" + ] + } + } + }, + "required": [ + "id", + "name", + "os", + "status", + "busy", + "labels" + ] + }, + "encoded_jit_config": { + "type": "string", + "description": "The base64 encoded runner configuration." + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Generates a configuration that can be passed to the runner application at startup.

\n

You must authenticate using an access token with the repo scope to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "

Created

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ] + }, { "serverUrl": "https://api.github.com", "verb": "post", @@ -121883,7 +122559,7 @@ } ], "previews": [], - "descriptionHTML": "

Remove a single repository from an installation. The authenticated user must have admin access to the repository.

\n

You must use a personal access token (which you can create via the command line or Basic Authentication) to access this endpoint.

", + "descriptionHTML": "

Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the repository_selection of selected.

\n

You must use a personal access token (which you can create via the command line or Basic Authentication) to access this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", @@ -121900,6 +122576,10 @@ { "httpStatusCode": "404", "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Returned when the application is installed on all repositories in the organization, or if this request would remove the last repository that the application has access to in the organization.

" } ] } @@ -204753,7 +205433,7 @@ "description": "

Validation failed, or the endpoint has been spammed.

" } ], - "descriptionHTML": "

Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the admin:org scope to use this endpoint.

\n

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" + "descriptionHTML": "

Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the admin:org scope to use this endpoint.

\n

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" }, { "serverUrl": "https://api.github.com", @@ -213085,7 +213765,7 @@ "description": "

Validation failed, or the endpoint has been spammed.

" } ], - "descriptionHTML": "

Creates or updates a secret for a user's codespace with an encrypted value. Encrypt your secret using\nLibSodium.

\n

You must authenticate using an access token with the codespace or codespace:secrets scope to use this endpoint. User must also have Codespaces access to use this endpoint.

\n

GitHub Apps must have write access to the codespaces_user_secrets user permission and codespaces_secrets repository permission on all referenced repositories to use this endpoint.

\n

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" + "descriptionHTML": "

Creates or updates a secret for a user's codespace with an encrypted value. Encrypt your secret using\nLibSodium.

\n

You must authenticate using an access token with the codespace or codespace:secrets scope to use this endpoint. User must also have Codespaces access to use this endpoint.

\n

GitHub Apps must have write access to the codespaces_user_secrets user permission and codespaces_secrets repository permission on all referenced repositories to use this endpoint.

\n

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" }, { "serverUrl": "https://api.github.com", @@ -242036,7 +242716,7 @@ "description": "

Response when updating a secret

" } ], - "descriptionHTML": "

Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization\npermission to use this endpoint.

\n

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" + "descriptionHTML": "

Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization\npermission to use this endpoint.

\n

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" }, { "serverUrl": "https://api.github.com", @@ -243682,7 +244362,7 @@ "description": "

Response when updating a secret

" } ], - "descriptionHTML": "

Creates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the repo scope to use this endpoint. GitHub Apps must have the dependabot_secrets repository\npermission to use this endpoint.

\n

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" + "descriptionHTML": "

Creates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the repo scope to use this endpoint. GitHub Apps must have the dependabot_secrets repository\npermission to use this endpoint.

\n

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" }, { "serverUrl": "https://api.github.com", @@ -288548,6 +289228,10 @@ "httpStatusCode": "201", "description": "

Created

" }, + { + "httpStatusCode": "400", + "description": "

Bad Request

" + }, { "httpStatusCode": "403", "description": "

Forbidden

" @@ -314921,8 +315605,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists events for a repository.

", "statusCodes": [ { "httpStatusCode": "200", @@ -319894,8 +320578,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Gets a single event by the event id.

", "statusCodes": [ { "httpStatusCode": "200", @@ -330041,8 +330725,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists all events for an issue.

", "statusCodes": [ { "httpStatusCode": "200", @@ -330220,8 +330904,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists all labels for an issue.

", "statusCodes": [ { "httpStatusCode": "200", @@ -330401,8 +331085,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Adds labels to an issue. If you provide an empty array of labels, all labels are removed from the issue.

", "statusCodes": [ { "httpStatusCode": "200", @@ -330667,8 +331351,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Removes all labels from an issue.

", "statusCodes": [ { "httpStatusCode": "204", @@ -331010,8 +331694,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists all labels for a repository.

", "statusCodes": [ { "httpStatusCode": "200", @@ -331171,8 +331855,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Creates a label for the specified repository with the given name and color. The name and color parameters are required. The color must be a valid hexadecimal color code.

", "statusCodes": [ { "httpStatusCode": "201", @@ -331320,8 +332004,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Gets a label using the given name.

", "statusCodes": [ { "httpStatusCode": "200", @@ -331490,8 +332174,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Updates a label using the given label name.

", "statusCodes": [ { "httpStatusCode": "200", @@ -331555,8 +332239,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Deletes a label using the given label name.

", "statusCodes": [ { "httpStatusCode": "204", @@ -331728,8 +332412,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists labels for issues in a milestone.

", "statusCodes": [ { "httpStatusCode": "200", @@ -332196,8 +332880,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists milestones for a repository.

", "statusCodes": [ { "httpStatusCode": "200", @@ -332638,8 +333322,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Creates a milestone.

", "statusCodes": [ { "httpStatusCode": "201", @@ -333056,8 +333740,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Gets a milestone using the given milestone number.

", "statusCodes": [ { "httpStatusCode": "200", @@ -333572,8 +334256,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Deletes a milestone using the given milestone number.

", "statusCodes": [ { "httpStatusCode": "204", @@ -349482,8 +350166,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

List all timeline events for an issue.

", "statusCodes": [ { "httpStatusCode": "200", @@ -350681,6 +351365,47 @@ "examples": [ "192.0.2.1" ] + }, + "domains": { + "type": "object", + "properties": { + "website": { + "type": "array", + "items": { + "type": "string", + "examples": [ + "example.com" + ] + } + }, + "codespaces": { + "type": "array", + "items": { + "type": "string", + "examples": [ + "example.com" + ] + } + }, + "copilot": { + "type": "array", + "items": { + "type": "string", + "examples": [ + "example.com" + ] + } + }, + "packages": { + "type": "array", + "items": { + "type": "string", + "examples": [ + "example.com" + ] + } + } + } } }, "required": [ @@ -378842,8 +379567,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Check if the provided user is a public member of the organization.

", "statusCodes": [ { "httpStatusCode": "204", @@ -378960,8 +379685,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default.

", "statusCodes": [ { "httpStatusCode": "204", @@ -379010,7 +379735,7 @@ } ], "bodyParameters": [], - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", @@ -379440,8 +380165,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists all of the authenticated user's organization memberships.

", "statusCodes": [ { "httpStatusCode": "200", @@ -379484,7 +380209,7 @@ } ], "bodyParameters": [], - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", @@ -379872,8 +380597,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

If the authenticated user is an active or pending member of the organization, this endpoint will return the user's membership. If the authenticated user is not affiliated with the organization, a 404 is returned. This endpoint will return a 403 if the request is made by a GitHub App that is blocked by the organization.

", "statusCodes": [ { "httpStatusCode": "200", @@ -379919,7 +380644,7 @@ ] } ], - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", @@ -380311,8 +381036,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Converts the authenticated user to an active member of the organization, if that user has a pending invitation from the organization.

", "statusCodes": [ { "httpStatusCode": "200", @@ -384054,6 +384779,24 @@ "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 + } } ], "bodyParameters": [], @@ -384078,14 +384821,18 @@ "name": "super cool ruleset", "source_type": "Organization", "source": "my-org", - "enforcement": "enabled" + "enforcement": "enabled", + "created_at": "2023-07-15T08:43:03Z", + "updated_at": "2023-08-23T16:29:47Z" }, { "id": 432, "name": "Another ruleset", "source_type": "Organization", "source": "my-org", - "enforcement": "enabled" + "enforcement": "enabled", + "created_at": "2023-08-15T08:43:03Z", + "updated_at": "2023-09-23T16:29:47Z" } ], "schema": { @@ -384289,7 +385036,7 @@ "oneOf": [ { "title": "creation", - "description": "Parameters to be used for the creation rule", + "description": "Only allow users with bypass permission to create matching refs.", "type": "object", "required": [ "type" @@ -384305,7 +385052,7 @@ }, { "title": "update", - "description": "Parameters to be used for the update rule", + "description": "Only allow users with bypass permission to update matching refs.", "type": "object", "required": [ "type" @@ -384333,7 +385080,7 @@ }, { "title": "deletion", - "description": "Parameters to be used for the deletion rule", + "description": "Only allow users with bypass permissions to delete matching refs.", "type": "object", "required": [ "type" @@ -384349,7 +385096,7 @@ }, { "title": "required_linear_history", - "description": "Parameters to be used for the required_linear_history rule", + "description": "Prevent merge commits from being pushed to matching branches.", "type": "object", "required": [ "type" @@ -384365,7 +385112,7 @@ }, { "title": "required_deployments", - "description": "Parameters to be used for the required_deployments rule", + "description": "Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.", "type": "object", "required": [ "type" @@ -384396,7 +385143,7 @@ }, { "title": "required_signatures", - "description": "Parameters to be used for the required_signatures rule", + "description": "Commits pushed to matching branches must have verified signatures.", "type": "object", "required": [ "type" @@ -384412,7 +385159,7 @@ }, { "title": "pull_request", - "description": "Parameters to be used for the pull_request rule", + "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", "type": "object", "required": [ "type" @@ -384462,7 +385209,7 @@ }, { "title": "required_status_checks", - "description": "Parameters to be used for the required_status_checks rule", + "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.", "type": "object", "required": [ "type" @@ -384513,7 +385260,7 @@ }, { "title": "non_fast_forward", - "description": "Parameters to be used for the non_fast_forward rule", + "description": "Prevent users with push access from force pushing to branches.", "type": "object", "required": [ "type" @@ -384764,6 +385511,14 @@ } ] } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" } } } @@ -384873,7 +385628,7 @@ { "type": "object", "name": "creation", - "description": "

Parameters to be used for the creation rule

", + "description": "

Only allow users with bypass permission to create matching refs.

", "isRequired": [ "type" ], @@ -384892,7 +385647,7 @@ { "type": "object", "name": "update", - "description": "

Parameters to be used for the update rule

", + "description": "

Only allow users with bypass permission to update matching refs.

", "isRequired": [ "type" ], @@ -384924,7 +385679,7 @@ { "type": "object", "name": "deletion", - "description": "

Parameters to be used for the deletion rule

", + "description": "

Only allow users with bypass permissions to delete matching refs.

", "isRequired": [ "type" ], @@ -384943,7 +385698,7 @@ { "type": "object", "name": "required_linear_history", - "description": "

Parameters to be used for the required_linear_history rule

", + "description": "

Prevent merge commits from being pushed to matching branches.

", "isRequired": [ "type" ], @@ -384962,7 +385717,7 @@ { "type": "object", "name": "required_deployments", - "description": "

Parameters to be used for the required_deployments rule

", + "description": "

Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.

", "isRequired": [ "type" ], @@ -384994,7 +385749,7 @@ { "type": "object", "name": "required_signatures", - "description": "

Parameters to be used for the required_signatures rule

", + "description": "

Commits pushed to matching branches must have verified signatures.

", "isRequired": [ "type" ], @@ -385013,7 +385768,7 @@ { "type": "object", "name": "pull_request", - "description": "

Parameters to be used for the pull_request rule

", + "description": "

Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.

", "isRequired": [ "type" ], @@ -385069,7 +385824,7 @@ { "type": "object", "name": "required_status_checks", - "description": "

Parameters to be used for the required_status_checks rule

", + "description": "

Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.

", "isRequired": [ "type" ], @@ -385120,7 +385875,7 @@ { "type": "object", "name": "non_fast_forward", - "description": "

Parameters to be used for the non_fast_forward rule

", + "description": "

Prevent users with push access from force pushing to branches.

", "isRequired": [ "type" ], @@ -385499,7 +386254,9 @@ "pattern": "github" } } - ] + ], + "created_at": "2023-08-15T08:43:03Z", + "updated_at": "2023-09-23T16:29:47Z" }, "schema": { "title": "Repository ruleset", @@ -385700,7 +386457,7 @@ "oneOf": [ { "title": "creation", - "description": "Parameters to be used for the creation rule", + "description": "Only allow users with bypass permission to create matching refs.", "type": "object", "required": [ "type" @@ -385716,7 +386473,7 @@ }, { "title": "update", - "description": "Parameters to be used for the update rule", + "description": "Only allow users with bypass permission to update matching refs.", "type": "object", "required": [ "type" @@ -385744,7 +386501,7 @@ }, { "title": "deletion", - "description": "Parameters to be used for the deletion rule", + "description": "Only allow users with bypass permissions to delete matching refs.", "type": "object", "required": [ "type" @@ -385760,7 +386517,7 @@ }, { "title": "required_linear_history", - "description": "Parameters to be used for the required_linear_history rule", + "description": "Prevent merge commits from being pushed to matching branches.", "type": "object", "required": [ "type" @@ -385776,7 +386533,7 @@ }, { "title": "required_deployments", - "description": "Parameters to be used for the required_deployments rule", + "description": "Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.", "type": "object", "required": [ "type" @@ -385807,7 +386564,7 @@ }, { "title": "required_signatures", - "description": "Parameters to be used for the required_signatures rule", + "description": "Commits pushed to matching branches must have verified signatures.", "type": "object", "required": [ "type" @@ -385823,7 +386580,7 @@ }, { "title": "pull_request", - "description": "Parameters to be used for the pull_request rule", + "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", "type": "object", "required": [ "type" @@ -385873,7 +386630,7 @@ }, { "title": "required_status_checks", - "description": "Parameters to be used for the required_status_checks rule", + "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.", "type": "object", "required": [ "type" @@ -385924,7 +386681,7 @@ }, { "title": "non_fast_forward", - "description": "Parameters to be used for the non_fast_forward rule", + "description": "Prevent users with push access from force pushing to branches.", "type": "object", "required": [ "type" @@ -386175,6 +386932,14 @@ } ] } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" } } } @@ -386284,7 +387049,9 @@ "pattern": "github" } } - ] + ], + "created_at": "2023-08-15T08:43:03Z", + "updated_at": "2023-09-23T16:29:47Z" }, "schema": { "title": "Repository ruleset", @@ -386485,7 +387252,7 @@ "oneOf": [ { "title": "creation", - "description": "Parameters to be used for the creation rule", + "description": "Only allow users with bypass permission to create matching refs.", "type": "object", "required": [ "type" @@ -386501,7 +387268,7 @@ }, { "title": "update", - "description": "Parameters to be used for the update rule", + "description": "Only allow users with bypass permission to update matching refs.", "type": "object", "required": [ "type" @@ -386529,7 +387296,7 @@ }, { "title": "deletion", - "description": "Parameters to be used for the deletion rule", + "description": "Only allow users with bypass permissions to delete matching refs.", "type": "object", "required": [ "type" @@ -386545,7 +387312,7 @@ }, { "title": "required_linear_history", - "description": "Parameters to be used for the required_linear_history rule", + "description": "Prevent merge commits from being pushed to matching branches.", "type": "object", "required": [ "type" @@ -386561,7 +387328,7 @@ }, { "title": "required_deployments", - "description": "Parameters to be used for the required_deployments rule", + "description": "Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.", "type": "object", "required": [ "type" @@ -386592,7 +387359,7 @@ }, { "title": "required_signatures", - "description": "Parameters to be used for the required_signatures rule", + "description": "Commits pushed to matching branches must have verified signatures.", "type": "object", "required": [ "type" @@ -386608,7 +387375,7 @@ }, { "title": "pull_request", - "description": "Parameters to be used for the pull_request rule", + "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", "type": "object", "required": [ "type" @@ -386658,7 +387425,7 @@ }, { "title": "required_status_checks", - "description": "Parameters to be used for the required_status_checks rule", + "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.", "type": "object", "required": [ "type" @@ -386709,7 +387476,7 @@ }, { "title": "non_fast_forward", - "description": "Parameters to be used for the non_fast_forward rule", + "description": "Prevent users with push access from force pushing to branches.", "type": "object", "required": [ "type" @@ -386960,6 +387727,14 @@ } ] } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" } } } @@ -387075,7 +387850,7 @@ { "type": "object", "name": "creation", - "description": "

Parameters to be used for the creation rule

", + "description": "

Only allow users with bypass permission to create matching refs.

", "isRequired": [ "type" ], @@ -387094,7 +387869,7 @@ { "type": "object", "name": "update", - "description": "

Parameters to be used for the update rule

", + "description": "

Only allow users with bypass permission to update matching refs.

", "isRequired": [ "type" ], @@ -387126,7 +387901,7 @@ { "type": "object", "name": "deletion", - "description": "

Parameters to be used for the deletion rule

", + "description": "

Only allow users with bypass permissions to delete matching refs.

", "isRequired": [ "type" ], @@ -387145,7 +387920,7 @@ { "type": "object", "name": "required_linear_history", - "description": "

Parameters to be used for the required_linear_history rule

", + "description": "

Prevent merge commits from being pushed to matching branches.

", "isRequired": [ "type" ], @@ -387164,7 +387939,7 @@ { "type": "object", "name": "required_deployments", - "description": "

Parameters to be used for the required_deployments rule

", + "description": "

Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.

", "isRequired": [ "type" ], @@ -387196,7 +387971,7 @@ { "type": "object", "name": "required_signatures", - "description": "

Parameters to be used for the required_signatures rule

", + "description": "

Commits pushed to matching branches must have verified signatures.

", "isRequired": [ "type" ], @@ -387215,7 +387990,7 @@ { "type": "object", "name": "pull_request", - "description": "

Parameters to be used for the pull_request rule

", + "description": "

Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.

", "isRequired": [ "type" ], @@ -387271,7 +388046,7 @@ { "type": "object", "name": "required_status_checks", - "description": "

Parameters to be used for the required_status_checks rule

", + "description": "

Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.

", "isRequired": [ "type" ], @@ -387322,7 +388097,7 @@ { "type": "object", "name": "non_fast_forward", - "description": "

Parameters to be used for the non_fast_forward rule

", + "description": "

Prevent users with push access from force pushing to branches.

", "isRequired": [ "type" ], @@ -387702,7 +388477,9 @@ "pattern": "github" } } - ] + ], + "created_at": "2023-08-15T08:43:03Z", + "updated_at": "2023-09-23T16:29:47Z" }, "schema": { "title": "Repository ruleset", @@ -387903,7 +388680,7 @@ "oneOf": [ { "title": "creation", - "description": "Parameters to be used for the creation rule", + "description": "Only allow users with bypass permission to create matching refs.", "type": "object", "required": [ "type" @@ -387919,7 +388696,7 @@ }, { "title": "update", - "description": "Parameters to be used for the update rule", + "description": "Only allow users with bypass permission to update matching refs.", "type": "object", "required": [ "type" @@ -387947,7 +388724,7 @@ }, { "title": "deletion", - "description": "Parameters to be used for the deletion rule", + "description": "Only allow users with bypass permissions to delete matching refs.", "type": "object", "required": [ "type" @@ -387963,7 +388740,7 @@ }, { "title": "required_linear_history", - "description": "Parameters to be used for the required_linear_history rule", + "description": "Prevent merge commits from being pushed to matching branches.", "type": "object", "required": [ "type" @@ -387979,7 +388756,7 @@ }, { "title": "required_deployments", - "description": "Parameters to be used for the required_deployments rule", + "description": "Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.", "type": "object", "required": [ "type" @@ -388010,7 +388787,7 @@ }, { "title": "required_signatures", - "description": "Parameters to be used for the required_signatures rule", + "description": "Commits pushed to matching branches must have verified signatures.", "type": "object", "required": [ "type" @@ -388026,7 +388803,7 @@ }, { "title": "pull_request", - "description": "Parameters to be used for the pull_request rule", + "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", "type": "object", "required": [ "type" @@ -388076,7 +388853,7 @@ }, { "title": "required_status_checks", - "description": "Parameters to be used for the required_status_checks rule", + "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.", "type": "object", "required": [ "type" @@ -388127,7 +388904,7 @@ }, { "title": "non_fast_forward", - "description": "Parameters to be used for the non_fast_forward rule", + "description": "Prevent users with push access from force pushing to branches.", "type": "object", "required": [ "type" @@ -388378,6 +389155,14 @@ } ] } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" } } } @@ -409640,8 +410425,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists projects for a user.

", "statusCodes": [ { "httpStatusCode": "200", @@ -409987,8 +410772,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Gets information about a project card.

", "statusCodes": [ { "httpStatusCode": "200", @@ -410426,8 +411211,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Deletes a project card

", "statusCodes": [ { "httpStatusCode": "204", @@ -410912,8 +411697,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists the project cards in a project.

", "statusCodes": [ { "httpStatusCode": "200", @@ -412176,8 +412961,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Gets information about a project column.

", "statusCodes": [ { "httpStatusCode": "200", @@ -412389,8 +413174,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Deletes a project column.

", "statusCodes": [ { "httpStatusCode": "204", @@ -412632,8 +413417,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists the project columns in a project.

", "statusCodes": [ { "httpStatusCode": "200", @@ -412784,8 +413569,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Creates a new project column.

", "statusCodes": [ { "httpStatusCode": "201", @@ -482998,12 +483783,16 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists the teams that have access to the specified repository and that are also visible to the authenticated user.

\n

For a public repository, a team is listed only if that team added the public repository explicitly.

\n

Personal access tokens require the following scopes:

\n\n

This endpoint is not compatible with fine-grained personal access tokens.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" } ] }, @@ -503289,6 +504078,24 @@ "type": "string" }, "x-multi-segment": true + }, + { + "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 + } } ], "bodyParameters": [], @@ -503334,7 +504141,7 @@ "oneOf": [ { "title": "creation", - "description": "Parameters to be used for the creation rule", + "description": "Only allow users with bypass permission to create matching refs.", "type": "object", "required": [ "type" @@ -503350,7 +504157,7 @@ }, { "title": "update", - "description": "Parameters to be used for the update rule", + "description": "Only allow users with bypass permission to update matching refs.", "type": "object", "required": [ "type" @@ -503378,7 +504185,7 @@ }, { "title": "deletion", - "description": "Parameters to be used for the deletion rule", + "description": "Only allow users with bypass permissions to delete matching refs.", "type": "object", "required": [ "type" @@ -503394,7 +504201,7 @@ }, { "title": "required_linear_history", - "description": "Parameters to be used for the required_linear_history rule", + "description": "Prevent merge commits from being pushed to matching branches.", "type": "object", "required": [ "type" @@ -503410,7 +504217,7 @@ }, { "title": "required_deployments", - "description": "Parameters to be used for the required_deployments rule", + "description": "Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.", "type": "object", "required": [ "type" @@ -503441,7 +504248,7 @@ }, { "title": "required_signatures", - "description": "Parameters to be used for the required_signatures rule", + "description": "Commits pushed to matching branches must have verified signatures.", "type": "object", "required": [ "type" @@ -503457,7 +504264,7 @@ }, { "title": "pull_request", - "description": "Parameters to be used for the pull_request rule", + "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", "type": "object", "required": [ "type" @@ -503507,7 +504314,7 @@ }, { "title": "required_status_checks", - "description": "Parameters to be used for the required_status_checks rule", + "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.", "type": "object", "required": [ "type" @@ -503558,7 +504365,7 @@ }, { "title": "non_fast_forward", - "description": "Parameters to be used for the non_fast_forward rule", + "description": "Prevent users with push access from force pushing to branches.", "type": "object", "required": [ "type" @@ -503848,6 +504655,24 @@ "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 + } + }, { "name": "includes_parents", "description": "

Include rulesets configured at higher levels that apply to this repository

", @@ -503881,14 +504706,18 @@ "name": "super cool ruleset", "source_type": "Repository", "source": "monalisa/my-repo", - "enforcement": "enabled" + "enforcement": "enabled", + "created_at": "2023-07-15T08:43:03Z", + "updated_at": "2023-08-23T16:29:47Z" }, { "id": 314, "name": "Another ruleset", "source_type": "Repository", "source": "monalisa/my-repo", - "enforcement": "enabled" + "enforcement": "enabled", + "created_at": "2023-08-15T08:43:03Z", + "updated_at": "2023-09-23T16:29:47Z" } ], "schema": { @@ -504092,7 +504921,7 @@ "oneOf": [ { "title": "creation", - "description": "Parameters to be used for the creation rule", + "description": "Only allow users with bypass permission to create matching refs.", "type": "object", "required": [ "type" @@ -504108,7 +504937,7 @@ }, { "title": "update", - "description": "Parameters to be used for the update rule", + "description": "Only allow users with bypass permission to update matching refs.", "type": "object", "required": [ "type" @@ -504136,7 +504965,7 @@ }, { "title": "deletion", - "description": "Parameters to be used for the deletion rule", + "description": "Only allow users with bypass permissions to delete matching refs.", "type": "object", "required": [ "type" @@ -504152,7 +504981,7 @@ }, { "title": "required_linear_history", - "description": "Parameters to be used for the required_linear_history rule", + "description": "Prevent merge commits from being pushed to matching branches.", "type": "object", "required": [ "type" @@ -504168,7 +504997,7 @@ }, { "title": "required_deployments", - "description": "Parameters to be used for the required_deployments rule", + "description": "Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.", "type": "object", "required": [ "type" @@ -504199,7 +505028,7 @@ }, { "title": "required_signatures", - "description": "Parameters to be used for the required_signatures rule", + "description": "Commits pushed to matching branches must have verified signatures.", "type": "object", "required": [ "type" @@ -504215,7 +505044,7 @@ }, { "title": "pull_request", - "description": "Parameters to be used for the pull_request rule", + "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", "type": "object", "required": [ "type" @@ -504265,7 +505094,7 @@ }, { "title": "required_status_checks", - "description": "Parameters to be used for the required_status_checks rule", + "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.", "type": "object", "required": [ "type" @@ -504316,7 +505145,7 @@ }, { "title": "non_fast_forward", - "description": "Parameters to be used for the non_fast_forward rule", + "description": "Prevent users with push access from force pushing to branches.", "type": "object", "required": [ "type" @@ -504567,6 +505396,14 @@ } ] } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" } } } @@ -504715,7 +505552,7 @@ { "type": "object", "name": "creation", - "description": "

Parameters to be used for the creation rule

", + "description": "

Only allow users with bypass permission to create matching refs.

", "isRequired": [ "type" ], @@ -504734,7 +505571,7 @@ { "type": "object", "name": "update", - "description": "

Parameters to be used for the update rule

", + "description": "

Only allow users with bypass permission to update matching refs.

", "isRequired": [ "type" ], @@ -504766,7 +505603,7 @@ { "type": "object", "name": "deletion", - "description": "

Parameters to be used for the deletion rule

", + "description": "

Only allow users with bypass permissions to delete matching refs.

", "isRequired": [ "type" ], @@ -504785,7 +505622,7 @@ { "type": "object", "name": "required_linear_history", - "description": "

Parameters to be used for the required_linear_history rule

", + "description": "

Prevent merge commits from being pushed to matching branches.

", "isRequired": [ "type" ], @@ -504804,7 +505641,7 @@ { "type": "object", "name": "required_deployments", - "description": "

Parameters to be used for the required_deployments rule

", + "description": "

Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.

", "isRequired": [ "type" ], @@ -504836,7 +505673,7 @@ { "type": "object", "name": "required_signatures", - "description": "

Parameters to be used for the required_signatures rule

", + "description": "

Commits pushed to matching branches must have verified signatures.

", "isRequired": [ "type" ], @@ -504855,7 +505692,7 @@ { "type": "object", "name": "pull_request", - "description": "

Parameters to be used for the pull_request rule

", + "description": "

Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.

", "isRequired": [ "type" ], @@ -504911,7 +505748,7 @@ { "type": "object", "name": "required_status_checks", - "description": "

Parameters to be used for the required_status_checks rule

", + "description": "

Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.

", "isRequired": [ "type" ], @@ -504962,7 +505799,7 @@ { "type": "object", "name": "non_fast_forward", - "description": "

Parameters to be used for the non_fast_forward rule

", + "description": "

Prevent users with push access from force pushing to branches.

", "isRequired": [ "type" ], @@ -505334,7 +506171,9 @@ "pattern": "github" } } - ] + ], + "created_at": "2023-07-15T08:43:03Z", + "updated_at": "2023-08-23T16:29:47Z" }, "schema": { "title": "Repository ruleset", @@ -505535,7 +506374,7 @@ "oneOf": [ { "title": "creation", - "description": "Parameters to be used for the creation rule", + "description": "Only allow users with bypass permission to create matching refs.", "type": "object", "required": [ "type" @@ -505551,7 +506390,7 @@ }, { "title": "update", - "description": "Parameters to be used for the update rule", + "description": "Only allow users with bypass permission to update matching refs.", "type": "object", "required": [ "type" @@ -505579,7 +506418,7 @@ }, { "title": "deletion", - "description": "Parameters to be used for the deletion rule", + "description": "Only allow users with bypass permissions to delete matching refs.", "type": "object", "required": [ "type" @@ -505595,7 +506434,7 @@ }, { "title": "required_linear_history", - "description": "Parameters to be used for the required_linear_history rule", + "description": "Prevent merge commits from being pushed to matching branches.", "type": "object", "required": [ "type" @@ -505611,7 +506450,7 @@ }, { "title": "required_deployments", - "description": "Parameters to be used for the required_deployments rule", + "description": "Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.", "type": "object", "required": [ "type" @@ -505642,7 +506481,7 @@ }, { "title": "required_signatures", - "description": "Parameters to be used for the required_signatures rule", + "description": "Commits pushed to matching branches must have verified signatures.", "type": "object", "required": [ "type" @@ -505658,7 +506497,7 @@ }, { "title": "pull_request", - "description": "Parameters to be used for the pull_request rule", + "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", "type": "object", "required": [ "type" @@ -505708,7 +506547,7 @@ }, { "title": "required_status_checks", - "description": "Parameters to be used for the required_status_checks rule", + "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.", "type": "object", "required": [ "type" @@ -505759,7 +506598,7 @@ }, { "title": "non_fast_forward", - "description": "Parameters to be used for the non_fast_forward rule", + "description": "Prevent users with push access from force pushing to branches.", "type": "object", "required": [ "type" @@ -506010,6 +506849,14 @@ } ] } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" } } } @@ -506129,7 +506976,9 @@ "pattern": "github" } } - ] + ], + "created_at": "2023-07-15T08:43:03Z", + "updated_at": "2023-08-23T16:29:47Z" }, "schema": { "title": "Repository ruleset", @@ -506330,7 +507179,7 @@ "oneOf": [ { "title": "creation", - "description": "Parameters to be used for the creation rule", + "description": "Only allow users with bypass permission to create matching refs.", "type": "object", "required": [ "type" @@ -506346,7 +507195,7 @@ }, { "title": "update", - "description": "Parameters to be used for the update rule", + "description": "Only allow users with bypass permission to update matching refs.", "type": "object", "required": [ "type" @@ -506374,7 +507223,7 @@ }, { "title": "deletion", - "description": "Parameters to be used for the deletion rule", + "description": "Only allow users with bypass permissions to delete matching refs.", "type": "object", "required": [ "type" @@ -506390,7 +507239,7 @@ }, { "title": "required_linear_history", - "description": "Parameters to be used for the required_linear_history rule", + "description": "Prevent merge commits from being pushed to matching branches.", "type": "object", "required": [ "type" @@ -506406,7 +507255,7 @@ }, { "title": "required_deployments", - "description": "Parameters to be used for the required_deployments rule", + "description": "Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.", "type": "object", "required": [ "type" @@ -506437,7 +507286,7 @@ }, { "title": "required_signatures", - "description": "Parameters to be used for the required_signatures rule", + "description": "Commits pushed to matching branches must have verified signatures.", "type": "object", "required": [ "type" @@ -506453,7 +507302,7 @@ }, { "title": "pull_request", - "description": "Parameters to be used for the pull_request rule", + "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", "type": "object", "required": [ "type" @@ -506503,7 +507352,7 @@ }, { "title": "required_status_checks", - "description": "Parameters to be used for the required_status_checks rule", + "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.", "type": "object", "required": [ "type" @@ -506554,7 +507403,7 @@ }, { "title": "non_fast_forward", - "description": "Parameters to be used for the non_fast_forward rule", + "description": "Prevent users with push access from force pushing to branches.", "type": "object", "required": [ "type" @@ -506805,6 +507654,14 @@ } ] } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" } } } @@ -506959,7 +507816,7 @@ { "type": "object", "name": "creation", - "description": "

Parameters to be used for the creation rule

", + "description": "

Only allow users with bypass permission to create matching refs.

", "isRequired": [ "type" ], @@ -506978,7 +507835,7 @@ { "type": "object", "name": "update", - "description": "

Parameters to be used for the update rule

", + "description": "

Only allow users with bypass permission to update matching refs.

", "isRequired": [ "type" ], @@ -507010,7 +507867,7 @@ { "type": "object", "name": "deletion", - "description": "

Parameters to be used for the deletion rule

", + "description": "

Only allow users with bypass permissions to delete matching refs.

", "isRequired": [ "type" ], @@ -507029,7 +507886,7 @@ { "type": "object", "name": "required_linear_history", - "description": "

Parameters to be used for the required_linear_history rule

", + "description": "

Prevent merge commits from being pushed to matching branches.

", "isRequired": [ "type" ], @@ -507048,7 +507905,7 @@ { "type": "object", "name": "required_deployments", - "description": "

Parameters to be used for the required_deployments rule

", + "description": "

Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.

", "isRequired": [ "type" ], @@ -507080,7 +507937,7 @@ { "type": "object", "name": "required_signatures", - "description": "

Parameters to be used for the required_signatures rule

", + "description": "

Commits pushed to matching branches must have verified signatures.

", "isRequired": [ "type" ], @@ -507099,7 +507956,7 @@ { "type": "object", "name": "pull_request", - "description": "

Parameters to be used for the pull_request rule

", + "description": "

Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.

", "isRequired": [ "type" ], @@ -507155,7 +508012,7 @@ { "type": "object", "name": "required_status_checks", - "description": "

Parameters to be used for the required_status_checks rule

", + "description": "

Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.

", "isRequired": [ "type" ], @@ -507206,7 +508063,7 @@ { "type": "object", "name": "non_fast_forward", - "description": "

Parameters to be used for the non_fast_forward rule

", + "description": "

Prevent users with push access from force pushing to branches.

", "isRequired": [ "type" ], @@ -507579,7 +508436,9 @@ "pattern": "github" } } - ] + ], + "created_at": "2023-07-15T08:43:03Z", + "updated_at": "2023-08-23T16:29:47Z" }, "schema": { "title": "Repository ruleset", @@ -507780,7 +508639,7 @@ "oneOf": [ { "title": "creation", - "description": "Parameters to be used for the creation rule", + "description": "Only allow users with bypass permission to create matching refs.", "type": "object", "required": [ "type" @@ -507796,7 +508655,7 @@ }, { "title": "update", - "description": "Parameters to be used for the update rule", + "description": "Only allow users with bypass permission to update matching refs.", "type": "object", "required": [ "type" @@ -507824,7 +508683,7 @@ }, { "title": "deletion", - "description": "Parameters to be used for the deletion rule", + "description": "Only allow users with bypass permissions to delete matching refs.", "type": "object", "required": [ "type" @@ -507840,7 +508699,7 @@ }, { "title": "required_linear_history", - "description": "Parameters to be used for the required_linear_history rule", + "description": "Prevent merge commits from being pushed to matching branches.", "type": "object", "required": [ "type" @@ -507856,7 +508715,7 @@ }, { "title": "required_deployments", - "description": "Parameters to be used for the required_deployments rule", + "description": "Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.", "type": "object", "required": [ "type" @@ -507887,7 +508746,7 @@ }, { "title": "required_signatures", - "description": "Parameters to be used for the required_signatures rule", + "description": "Commits pushed to matching branches must have verified signatures.", "type": "object", "required": [ "type" @@ -507903,7 +508762,7 @@ }, { "title": "pull_request", - "description": "Parameters to be used for the pull_request rule", + "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", "type": "object", "required": [ "type" @@ -507953,7 +508812,7 @@ }, { "title": "required_status_checks", - "description": "Parameters to be used for the required_status_checks rule", + "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.", "type": "object", "required": [ "type" @@ -508004,7 +508863,7 @@ }, { "title": "non_fast_forward", - "description": "Parameters to be used for the non_fast_forward rule", + "description": "Prevent users with push access from force pushing to branches.", "type": "object", "required": [ "type" @@ -508255,6 +509114,14 @@ } ] } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" } } } diff --git a/src/rest/data/ghes-3.4/schema.json b/src/rest/data/ghes-3.4/schema.json index d9bddb4273..983cdc7f5e 100644 --- a/src/rest/data/ghes-3.4/schema.json +++ b/src/rest/data/ghes-3.4/schema.json @@ -4373,7 +4373,7 @@ "description": "

Response when updating a secret

" } ], - "descriptionHTML": "

Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. 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

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" + "descriptionHTML": "

Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. 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

*Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -6028,7 +6028,7 @@ "description": "

Response when updating a secret

" } ], - "descriptionHTML": "

Creates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use\nthis endpoint.

\n

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" + "descriptionHTML": "

Creates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use\nthis endpoint.

\n

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -6550,7 +6550,7 @@ "description": "

Response when updating a secret

" } ], - "descriptionHTML": "

Creates or updates an environment secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use\nthis endpoint.

\n

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" + "descriptionHTML": "

Creates or updates an environment secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use\nthis endpoint.

\n

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -163561,7 +163561,7 @@ "description": "

Response when updating a secret

" } ], - "descriptionHTML": "

Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization\npermission to use this endpoint.

\n

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" + "descriptionHTML": "

Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization\npermission to use this endpoint.

\n

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -165192,7 +165192,7 @@ "description": "

Response when updating a secret

" } ], - "descriptionHTML": "

Creates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the repo scope to use this endpoint. GitHub Apps must have the dependabot_secrets repository\npermission to use this endpoint.

\n

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" + "descriptionHTML": "

Creates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the repo scope to use this endpoint. GitHub Apps must have the dependabot_secrets repository\npermission to use this endpoint.

\n

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -215965,6 +215965,10 @@ "httpStatusCode": "201", "description": "

Created

" }, + { + "httpStatusCode": "400", + "description": "

Bad Request

" + }, { "httpStatusCode": "403", "description": "

Forbidden

" @@ -241788,8 +241792,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists events for a repository.

", "statusCodes": [ { "httpStatusCode": "200", @@ -246661,8 +246665,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Gets a single event by the event id.

", "statusCodes": [ { "httpStatusCode": "200", @@ -256788,8 +256792,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists all events for an issue.

", "statusCodes": [ { "httpStatusCode": "200", @@ -256967,8 +256971,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists all labels for an issue.

", "statusCodes": [ { "httpStatusCode": "200", @@ -257148,8 +257152,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Adds labels to an issue. If you provide an empty array of labels, all labels are removed from the issue.

", "statusCodes": [ { "httpStatusCode": "200", @@ -257414,8 +257418,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Removes all labels from an issue.

", "statusCodes": [ { "httpStatusCode": "204", @@ -257757,8 +257761,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists all labels for a repository.

", "statusCodes": [ { "httpStatusCode": "200", @@ -257918,8 +257922,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Creates a label for the specified repository with the given name and color. The name and color parameters are required. The color must be a valid hexadecimal color code.

", "statusCodes": [ { "httpStatusCode": "201", @@ -258067,8 +258071,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Gets a label using the given name.

", "statusCodes": [ { "httpStatusCode": "200", @@ -258237,8 +258241,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Updates a label using the given label name.

", "statusCodes": [ { "httpStatusCode": "200", @@ -258302,8 +258306,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Deletes a label using the given label name.

", "statusCodes": [ { "httpStatusCode": "204", @@ -258475,8 +258479,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists labels for issues in a milestone.

", "statusCodes": [ { "httpStatusCode": "200", @@ -258943,8 +258947,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists milestones for a repository.

", "statusCodes": [ { "httpStatusCode": "200", @@ -259385,8 +259389,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Creates a milestone.

", "statusCodes": [ { "httpStatusCode": "201", @@ -259803,8 +259807,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Gets a milestone using the given milestone number.

", "statusCodes": [ { "httpStatusCode": "200", @@ -260319,8 +260323,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Deletes a milestone using the given milestone number.

", "statusCodes": [ { "httpStatusCode": "204", @@ -276119,8 +276123,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

List all timeline events for an issue.

", "statusCodes": [ { "httpStatusCode": "200", @@ -277199,6 +277203,47 @@ "192.0.2.1" ] }, + "domains": { + "type": "object", + "properties": { + "website": { + "type": "array", + "items": { + "type": "string", + "examples": [ + "example.com" + ] + } + }, + "codespaces": { + "type": "array", + "items": { + "type": "string", + "examples": [ + "example.com" + ] + } + }, + "copilot": { + "type": "array", + "items": { + "type": "string", + "examples": [ + "example.com" + ] + } + }, + "packages": { + "type": "array", + "items": { + "type": "string", + "examples": [ + "example.com" + ] + } + } + } + }, "installed_version": { "type": "string", "examples": [ @@ -302223,8 +302268,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Check if the provided user is a public member of the organization.

", "statusCodes": [ { "httpStatusCode": "204", @@ -302341,8 +302386,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default.

", "statusCodes": [ { "httpStatusCode": "204", @@ -302391,7 +302436,7 @@ } ], "bodyParameters": [], - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", @@ -302821,8 +302866,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists all of the authenticated user's organization memberships.

", "statusCodes": [ { "httpStatusCode": "200", @@ -302865,7 +302910,7 @@ } ], "bodyParameters": [], - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", @@ -303253,8 +303298,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

If the authenticated user is an active or pending member of the organization, this endpoint will return the user's membership. If the authenticated user is not affiliated with the organization, a 404 is returned. This endpoint will return a 403 if the request is made by a GitHub App that is blocked by the organization.

", "statusCodes": [ { "httpStatusCode": "200", @@ -303300,7 +303345,7 @@ ] } ], - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", @@ -303692,8 +303737,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Converts the authenticated user to an active member of the organization, if that user has a pending invitation from the organization.

", "statusCodes": [ { "httpStatusCode": "200", @@ -311163,8 +311208,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists projects for a user.

", "statusCodes": [ { "httpStatusCode": "200", @@ -311510,8 +311555,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Gets information about a project card.

", "statusCodes": [ { "httpStatusCode": "200", @@ -311949,8 +311994,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Deletes a project card

", "statusCodes": [ { "httpStatusCode": "204", @@ -312435,8 +312480,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists the project cards in a project.

", "statusCodes": [ { "httpStatusCode": "200", @@ -313699,8 +313744,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Gets information about a project column.

", "statusCodes": [ { "httpStatusCode": "200", @@ -313912,8 +313957,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Deletes a project column.

", "statusCodes": [ { "httpStatusCode": "204", @@ -314155,8 +314200,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists the project columns in a project.

", "statusCodes": [ { "httpStatusCode": "200", @@ -314307,8 +314352,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Creates a new project column.

", "statusCodes": [ { "httpStatusCode": "201", @@ -382898,12 +382943,16 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists the teams that have access to the specified repository and that are also visible to the authenticated user.

\n

For a public repository, a team is listed only if that team added the public repository explicitly.

\n

Personal access tokens require the following scopes:

\n\n

This endpoint is not compatible with fine-grained personal access tokens.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" } ] }, diff --git a/src/rest/data/ghes-3.5/schema.json b/src/rest/data/ghes-3.5/schema.json index 67ca113195..4ca66bf897 100644 --- a/src/rest/data/ghes-3.5/schema.json +++ b/src/rest/data/ghes-3.5/schema.json @@ -5297,7 +5297,7 @@ "description": "

Response when updating a secret

" } ], - "descriptionHTML": "

Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. 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

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" + "descriptionHTML": "

Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. 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

*Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -6958,7 +6958,7 @@ "description": "

Response when updating a secret

" } ], - "descriptionHTML": "

Creates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use\nthis endpoint.

\n

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" + "descriptionHTML": "

Creates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use\nthis endpoint.

\n

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -7480,7 +7480,7 @@ "description": "

Response when updating a secret

" } ], - "descriptionHTML": "

Creates or updates an environment secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use\nthis endpoint.

\n

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" + "descriptionHTML": "

Creates or updates an environment secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use\nthis endpoint.

\n

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -170836,7 +170836,7 @@ "description": "

Response when updating a secret

" } ], - "descriptionHTML": "

Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization\npermission to use this endpoint.

\n

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" + "descriptionHTML": "

Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization\npermission to use this endpoint.

\n

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -172473,7 +172473,7 @@ "description": "

Response when updating a secret

" } ], - "descriptionHTML": "

Creates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the repo scope to use this endpoint. GitHub Apps must have the dependabot_secrets repository\npermission to use this endpoint.

\n

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" + "descriptionHTML": "

Creates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the repo scope to use this endpoint. GitHub Apps must have the dependabot_secrets repository\npermission to use this endpoint.

\n

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -223246,6 +223246,10 @@ "httpStatusCode": "201", "description": "

Created

" }, + { + "httpStatusCode": "400", + "description": "

Bad Request

" + }, { "httpStatusCode": "403", "description": "

Forbidden

" @@ -249069,8 +249073,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists events for a repository.

", "statusCodes": [ { "httpStatusCode": "200", @@ -253942,8 +253946,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Gets a single event by the event id.

", "statusCodes": [ { "httpStatusCode": "200", @@ -264069,8 +264073,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists all events for an issue.

", "statusCodes": [ { "httpStatusCode": "200", @@ -264248,8 +264252,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists all labels for an issue.

", "statusCodes": [ { "httpStatusCode": "200", @@ -264429,8 +264433,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Adds labels to an issue. If you provide an empty array of labels, all labels are removed from the issue.

", "statusCodes": [ { "httpStatusCode": "200", @@ -264695,8 +264699,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Removes all labels from an issue.

", "statusCodes": [ { "httpStatusCode": "204", @@ -265038,8 +265042,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists all labels for a repository.

", "statusCodes": [ { "httpStatusCode": "200", @@ -265199,8 +265203,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Creates a label for the specified repository with the given name and color. The name and color parameters are required. The color must be a valid hexadecimal color code.

", "statusCodes": [ { "httpStatusCode": "201", @@ -265348,8 +265352,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Gets a label using the given name.

", "statusCodes": [ { "httpStatusCode": "200", @@ -265518,8 +265522,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Updates a label using the given label name.

", "statusCodes": [ { "httpStatusCode": "200", @@ -265583,8 +265587,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Deletes a label using the given label name.

", "statusCodes": [ { "httpStatusCode": "204", @@ -265756,8 +265760,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists labels for issues in a milestone.

", "statusCodes": [ { "httpStatusCode": "200", @@ -266224,8 +266228,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists milestones for a repository.

", "statusCodes": [ { "httpStatusCode": "200", @@ -266666,8 +266670,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Creates a milestone.

", "statusCodes": [ { "httpStatusCode": "201", @@ -267084,8 +267088,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Gets a milestone using the given milestone number.

", "statusCodes": [ { "httpStatusCode": "200", @@ -267600,8 +267604,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Deletes a milestone using the given milestone number.

", "statusCodes": [ { "httpStatusCode": "204", @@ -283400,8 +283404,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

List all timeline events for an issue.

", "statusCodes": [ { "httpStatusCode": "200", @@ -284480,6 +284484,47 @@ "192.0.2.1" ] }, + "domains": { + "type": "object", + "properties": { + "website": { + "type": "array", + "items": { + "type": "string", + "examples": [ + "example.com" + ] + } + }, + "codespaces": { + "type": "array", + "items": { + "type": "string", + "examples": [ + "example.com" + ] + } + }, + "copilot": { + "type": "array", + "items": { + "type": "string", + "examples": [ + "example.com" + ] + } + }, + "packages": { + "type": "array", + "items": { + "type": "string", + "examples": [ + "example.com" + ] + } + } + } + }, "installed_version": { "type": "string", "examples": [ @@ -309516,8 +309561,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Check if the provided user is a public member of the organization.

", "statusCodes": [ { "httpStatusCode": "204", @@ -309634,8 +309679,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default.

", "statusCodes": [ { "httpStatusCode": "204", @@ -309684,7 +309729,7 @@ } ], "bodyParameters": [], - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", @@ -310114,8 +310159,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists all of the authenticated user's organization memberships.

", "statusCodes": [ { "httpStatusCode": "200", @@ -310158,7 +310203,7 @@ } ], "bodyParameters": [], - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", @@ -310546,8 +310591,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

If the authenticated user is an active or pending member of the organization, this endpoint will return the user's membership. If the authenticated user is not affiliated with the organization, a 404 is returned. This endpoint will return a 403 if the request is made by a GitHub App that is blocked by the organization.

", "statusCodes": [ { "httpStatusCode": "200", @@ -310593,7 +310638,7 @@ ] } ], - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", @@ -310985,8 +311030,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Converts the authenticated user to an active member of the organization, if that user has a pending invitation from the organization.

", "statusCodes": [ { "httpStatusCode": "200", @@ -318456,8 +318501,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists projects for a user.

", "statusCodes": [ { "httpStatusCode": "200", @@ -318803,8 +318848,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Gets information about a project card.

", "statusCodes": [ { "httpStatusCode": "200", @@ -319242,8 +319287,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Deletes a project card

", "statusCodes": [ { "httpStatusCode": "204", @@ -319728,8 +319773,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists the project cards in a project.

", "statusCodes": [ { "httpStatusCode": "200", @@ -320992,8 +321037,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Gets information about a project column.

", "statusCodes": [ { "httpStatusCode": "200", @@ -321205,8 +321250,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Deletes a project column.

", "statusCodes": [ { "httpStatusCode": "204", @@ -321448,8 +321493,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists the project columns in a project.

", "statusCodes": [ { "httpStatusCode": "200", @@ -321600,8 +321645,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Creates a new project column.

", "statusCodes": [ { "httpStatusCode": "201", @@ -390304,12 +390349,16 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists the teams that have access to the specified repository and that are also visible to the authenticated user.

\n

For a public repository, a team is listed only if that team added the public repository explicitly.

\n

Personal access tokens require the following scopes:

\n\n

This endpoint is not compatible with fine-grained personal access tokens.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" } ] }, diff --git a/src/rest/data/ghes-3.6/schema.json b/src/rest/data/ghes-3.6/schema.json index 1676c228d4..31d9982631 100644 --- a/src/rest/data/ghes-3.6/schema.json +++ b/src/rest/data/ghes-3.6/schema.json @@ -5714,7 +5714,7 @@ "description": "

Response when updating a secret

" } ], - "descriptionHTML": "

Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. 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

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" + "descriptionHTML": "

Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. 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

*Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -7381,7 +7381,7 @@ "description": "

Response when updating a secret

" } ], - "descriptionHTML": "

Creates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use\nthis endpoint.

\n

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" + "descriptionHTML": "

Creates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use\nthis endpoint.

\n

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -7903,7 +7903,7 @@ "description": "

Response when updating a secret

" } ], - "descriptionHTML": "

Creates or updates an environment secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use\nthis endpoint.

\n

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" + "descriptionHTML": "

Creates or updates an environment secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use\nthis endpoint.

\n

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -173623,7 +173623,7 @@ "description": "

Response when updating a secret

" } ], - "descriptionHTML": "

Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization\npermission to use this endpoint.

\n

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" + "descriptionHTML": "

Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization\npermission to use this endpoint.

\n

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -175266,7 +175266,7 @@ "description": "

Response when updating a secret

" } ], - "descriptionHTML": "

Creates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the repo scope to use this endpoint. GitHub Apps must have the dependabot_secrets repository\npermission to use this endpoint.

\n

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" + "descriptionHTML": "

Creates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the repo scope to use this endpoint. GitHub Apps must have the dependabot_secrets repository\npermission to use this endpoint.

\n

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -231909,6 +231909,10 @@ "httpStatusCode": "201", "description": "

Created

" }, + { + "httpStatusCode": "400", + "description": "

Bad Request

" + }, { "httpStatusCode": "403", "description": "

Forbidden

" @@ -258224,8 +258228,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists events for a repository.

", "statusCodes": [ { "httpStatusCode": "200", @@ -263179,8 +263183,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Gets a single event by the event id.

", "statusCodes": [ { "httpStatusCode": "200", @@ -273306,8 +273310,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists all events for an issue.

", "statusCodes": [ { "httpStatusCode": "200", @@ -273485,8 +273489,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists all labels for an issue.

", "statusCodes": [ { "httpStatusCode": "200", @@ -273666,8 +273670,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Adds labels to an issue. If you provide an empty array of labels, all labels are removed from the issue.

", "statusCodes": [ { "httpStatusCode": "200", @@ -273932,8 +273936,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Removes all labels from an issue.

", "statusCodes": [ { "httpStatusCode": "204", @@ -274275,8 +274279,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists all labels for a repository.

", "statusCodes": [ { "httpStatusCode": "200", @@ -274436,8 +274440,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Creates a label for the specified repository with the given name and color. The name and color parameters are required. The color must be a valid hexadecimal color code.

", "statusCodes": [ { "httpStatusCode": "201", @@ -274585,8 +274589,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Gets a label using the given name.

", "statusCodes": [ { "httpStatusCode": "200", @@ -274755,8 +274759,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Updates a label using the given label name.

", "statusCodes": [ { "httpStatusCode": "200", @@ -274820,8 +274824,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Deletes a label using the given label name.

", "statusCodes": [ { "httpStatusCode": "204", @@ -274993,8 +274997,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists labels for issues in a milestone.

", "statusCodes": [ { "httpStatusCode": "200", @@ -275461,8 +275465,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists milestones for a repository.

", "statusCodes": [ { "httpStatusCode": "200", @@ -275903,8 +275907,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Creates a milestone.

", "statusCodes": [ { "httpStatusCode": "201", @@ -276321,8 +276325,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Gets a milestone using the given milestone number.

", "statusCodes": [ { "httpStatusCode": "200", @@ -276837,8 +276841,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Deletes a milestone using the given milestone number.

", "statusCodes": [ { "httpStatusCode": "204", @@ -292719,8 +292723,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

List all timeline events for an issue.

", "statusCodes": [ { "httpStatusCode": "200", @@ -293799,6 +293803,47 @@ "192.0.2.1" ] }, + "domains": { + "type": "object", + "properties": { + "website": { + "type": "array", + "items": { + "type": "string", + "examples": [ + "example.com" + ] + } + }, + "codespaces": { + "type": "array", + "items": { + "type": "string", + "examples": [ + "example.com" + ] + } + }, + "copilot": { + "type": "array", + "items": { + "type": "string", + "examples": [ + "example.com" + ] + } + }, + "packages": { + "type": "array", + "items": { + "type": "string", + "examples": [ + "example.com" + ] + } + } + } + }, "installed_version": { "type": "string", "examples": [ @@ -319278,8 +319323,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Check if the provided user is a public member of the organization.

", "statusCodes": [ { "httpStatusCode": "204", @@ -319396,8 +319441,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default.

", "statusCodes": [ { "httpStatusCode": "204", @@ -319446,7 +319491,7 @@ } ], "bodyParameters": [], - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", @@ -319876,8 +319921,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists all of the authenticated user's organization memberships.

", "statusCodes": [ { "httpStatusCode": "200", @@ -319920,7 +319965,7 @@ } ], "bodyParameters": [], - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", @@ -320308,8 +320353,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

If the authenticated user is an active or pending member of the organization, this endpoint will return the user's membership. If the authenticated user is not affiliated with the organization, a 404 is returned. This endpoint will return a 403 if the request is made by a GitHub App that is blocked by the organization.

", "statusCodes": [ { "httpStatusCode": "200", @@ -320355,7 +320400,7 @@ ] } ], - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", @@ -320747,8 +320792,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Converts the authenticated user to an active member of the organization, if that user has a pending invitation from the organization.

", "statusCodes": [ { "httpStatusCode": "200", @@ -328218,8 +328263,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists projects for a user.

", "statusCodes": [ { "httpStatusCode": "200", @@ -328565,8 +328610,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Gets information about a project card.

", "statusCodes": [ { "httpStatusCode": "200", @@ -329004,8 +329049,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Deletes a project card

", "statusCodes": [ { "httpStatusCode": "204", @@ -329490,8 +329535,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists the project cards in a project.

", "statusCodes": [ { "httpStatusCode": "200", @@ -330754,8 +330799,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Gets information about a project column.

", "statusCodes": [ { "httpStatusCode": "200", @@ -330967,8 +331012,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Deletes a project column.

", "statusCodes": [ { "httpStatusCode": "204", @@ -331210,8 +331255,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists the project columns in a project.

", "statusCodes": [ { "httpStatusCode": "200", @@ -331362,8 +331407,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Creates a new project column.

", "statusCodes": [ { "httpStatusCode": "201", @@ -401281,12 +401326,16 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists the teams that have access to the specified repository and that are also visible to the authenticated user.

\n

For a public repository, a team is listed only if that team added the public repository explicitly.

\n

Personal access tokens require the following scopes:

\n\n

This endpoint is not compatible with fine-grained personal access tokens.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" } ] }, diff --git a/src/rest/data/ghes-3.7/schema.json b/src/rest/data/ghes-3.7/schema.json index d844e5d537..c83c4d138d 100644 --- a/src/rest/data/ghes-3.7/schema.json +++ b/src/rest/data/ghes-3.7/schema.json @@ -6480,7 +6480,7 @@ "description": "

Response when updating a secret

" } ], - "descriptionHTML": "

Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. 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

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" + "descriptionHTML": "

Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. 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

*Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -8150,7 +8150,7 @@ "description": "

Response when updating a secret

" } ], - "descriptionHTML": "

Creates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use\nthis endpoint.

\n

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" + "descriptionHTML": "

Creates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use\nthis endpoint.

\n

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -8672,7 +8672,7 @@ "description": "

Response when updating a secret

" } ], - "descriptionHTML": "

Creates or updates an environment secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use\nthis endpoint.

\n

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" + "descriptionHTML": "

Creates or updates an environment secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use\nthis endpoint.

\n

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -176074,7 +176074,7 @@ "description": "

Response when updating a secret

" } ], - "descriptionHTML": "

Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization\npermission to use this endpoint.

\n

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" + "descriptionHTML": "

Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization\npermission to use this endpoint.

\n

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -177720,7 +177720,7 @@ "description": "

Response when updating a secret

" } ], - "descriptionHTML": "

Creates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the repo scope to use this endpoint. GitHub Apps must have the dependabot_secrets repository\npermission to use this endpoint.

\n

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" + "descriptionHTML": "

Creates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the repo scope to use this endpoint. GitHub Apps must have the dependabot_secrets repository\npermission to use this endpoint.

\n

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -234772,6 +234772,10 @@ "httpStatusCode": "201", "description": "

Created

" }, + { + "httpStatusCode": "400", + "description": "

Bad Request

" + }, { "httpStatusCode": "403", "description": "

Forbidden

" @@ -261135,8 +261139,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists events for a repository.

", "statusCodes": [ { "httpStatusCode": "200", @@ -266098,8 +266102,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Gets a single event by the event id.

", "statusCodes": [ { "httpStatusCode": "200", @@ -276225,8 +276229,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists all events for an issue.

", "statusCodes": [ { "httpStatusCode": "200", @@ -276404,8 +276408,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists all labels for an issue.

", "statusCodes": [ { "httpStatusCode": "200", @@ -276585,8 +276589,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Adds labels to an issue. If you provide an empty array of labels, all labels are removed from the issue.

", "statusCodes": [ { "httpStatusCode": "200", @@ -276851,8 +276855,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Removes all labels from an issue.

", "statusCodes": [ { "httpStatusCode": "204", @@ -277194,8 +277198,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists all labels for a repository.

", "statusCodes": [ { "httpStatusCode": "200", @@ -277355,8 +277359,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Creates a label for the specified repository with the given name and color. The name and color parameters are required. The color must be a valid hexadecimal color code.

", "statusCodes": [ { "httpStatusCode": "201", @@ -277504,8 +277508,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Gets a label using the given name.

", "statusCodes": [ { "httpStatusCode": "200", @@ -277674,8 +277678,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Updates a label using the given label name.

", "statusCodes": [ { "httpStatusCode": "200", @@ -277739,8 +277743,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Deletes a label using the given label name.

", "statusCodes": [ { "httpStatusCode": "204", @@ -277912,8 +277916,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists labels for issues in a milestone.

", "statusCodes": [ { "httpStatusCode": "200", @@ -278380,8 +278384,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists milestones for a repository.

", "statusCodes": [ { "httpStatusCode": "200", @@ -278822,8 +278826,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Creates a milestone.

", "statusCodes": [ { "httpStatusCode": "201", @@ -279240,8 +279244,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Gets a milestone using the given milestone number.

", "statusCodes": [ { "httpStatusCode": "200", @@ -279756,8 +279760,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Deletes a milestone using the given milestone number.

", "statusCodes": [ { "httpStatusCode": "204", @@ -295646,8 +295650,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

List all timeline events for an issue.

", "statusCodes": [ { "httpStatusCode": "200", @@ -296726,6 +296730,47 @@ "192.0.2.1" ] }, + "domains": { + "type": "object", + "properties": { + "website": { + "type": "array", + "items": { + "type": "string", + "examples": [ + "example.com" + ] + } + }, + "codespaces": { + "type": "array", + "items": { + "type": "string", + "examples": [ + "example.com" + ] + } + }, + "copilot": { + "type": "array", + "items": { + "type": "string", + "examples": [ + "example.com" + ] + } + }, + "packages": { + "type": "array", + "items": { + "type": "string", + "examples": [ + "example.com" + ] + } + } + } + }, "installed_version": { "type": "string", "examples": [ @@ -322464,8 +322509,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Check if the provided user is a public member of the organization.

", "statusCodes": [ { "httpStatusCode": "204", @@ -322582,8 +322627,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default.

", "statusCodes": [ { "httpStatusCode": "204", @@ -322632,7 +322677,7 @@ } ], "bodyParameters": [], - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", @@ -323062,8 +323107,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists all of the authenticated user's organization memberships.

", "statusCodes": [ { "httpStatusCode": "200", @@ -323106,7 +323151,7 @@ } ], "bodyParameters": [], - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", @@ -323494,8 +323539,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

If the authenticated user is an active or pending member of the organization, this endpoint will return the user's membership. If the authenticated user is not affiliated with the organization, a 404 is returned. This endpoint will return a 403 if the request is made by a GitHub App that is blocked by the organization.

", "statusCodes": [ { "httpStatusCode": "200", @@ -323541,7 +323586,7 @@ ] } ], - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", @@ -323933,8 +323978,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Converts the authenticated user to an active member of the organization, if that user has a pending invitation from the organization.

", "statusCodes": [ { "httpStatusCode": "200", @@ -331834,8 +331879,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists projects for a user.

", "statusCodes": [ { "httpStatusCode": "200", @@ -332181,8 +332226,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Gets information about a project card.

", "statusCodes": [ { "httpStatusCode": "200", @@ -332620,8 +332665,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Deletes a project card

", "statusCodes": [ { "httpStatusCode": "204", @@ -333106,8 +333151,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists the project cards in a project.

", "statusCodes": [ { "httpStatusCode": "200", @@ -334370,8 +334415,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Gets information about a project column.

", "statusCodes": [ { "httpStatusCode": "200", @@ -334583,8 +334628,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Deletes a project column.

", "statusCodes": [ { "httpStatusCode": "204", @@ -334826,8 +334871,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists the project columns in a project.

", "statusCodes": [ { "httpStatusCode": "200", @@ -334978,8 +335023,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Creates a new project column.

", "statusCodes": [ { "httpStatusCode": "201", @@ -405016,12 +405061,16 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists the teams that have access to the specified repository and that are also visible to the authenticated user.

\n

For a public repository, a team is listed only if that team added the public repository explicitly.

\n

Personal access tokens require the following scopes:

\n\n

This endpoint is not compatible with fine-grained personal access tokens.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" } ] }, diff --git a/src/rest/data/ghes-3.8/schema.json b/src/rest/data/ghes-3.8/schema.json index 3560c61809..4b34292316 100644 --- a/src/rest/data/ghes-3.8/schema.json +++ b/src/rest/data/ghes-3.8/schema.json @@ -14671,7 +14671,7 @@ "description": "

Response when updating a secret

" } ], - "descriptionHTML": "

Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. 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

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" + "descriptionHTML": "

Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. 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

*Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -16341,7 +16341,7 @@ "description": "

Response when updating a secret

" } ], - "descriptionHTML": "

Creates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use\nthis endpoint.

\n

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" + "descriptionHTML": "

Creates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use\nthis endpoint.

\n

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -16863,7 +16863,7 @@ "description": "

Response when updating a secret

" } ], - "descriptionHTML": "

Creates or updates an environment secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use\nthis endpoint.

\n

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" + "descriptionHTML": "

Creates or updates an environment secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use\nthis endpoint.

\n

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -196861,7 +196861,7 @@ "description": "

Response when updating a secret

" } ], - "descriptionHTML": "

Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization\npermission to use this endpoint.

\n

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" + "descriptionHTML": "

Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization\npermission to use this endpoint.

\n

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -198507,7 +198507,7 @@ "description": "

Response when updating a secret

" } ], - "descriptionHTML": "

Creates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the repo scope to use this endpoint. GitHub Apps must have the dependabot_secrets repository\npermission to use this endpoint.

\n

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" + "descriptionHTML": "

Creates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the repo scope to use this endpoint. GitHub Apps must have the dependabot_secrets repository\npermission to use this endpoint.

\n

Example encrypting a secret using Node.js

\n

Encrypt your secret using the libsodium-wrappers library.

\n
const sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n  // Convert Secret & Base64 key to Uint8Array.\n  let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n  let binsec = sodium.from_string(secret)\n\n  //Encrypt the secret using LibSodium\n  let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n  // Convert encrypted Uint8Array to Base64\n  let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n  console.log(output)\n});\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from 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

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var 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

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"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
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -255820,6 +255820,10 @@ "httpStatusCode": "201", "description": "

Created

" }, + { + "httpStatusCode": "400", + "description": "

Bad Request

" + }, { "httpStatusCode": "403", "description": "

Forbidden

" @@ -282183,8 +282187,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists events for a repository.

", "statusCodes": [ { "httpStatusCode": "200", @@ -287146,8 +287150,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Gets a single event by the event id.

", "statusCodes": [ { "httpStatusCode": "200", @@ -297273,8 +297277,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists all events for an issue.

", "statusCodes": [ { "httpStatusCode": "200", @@ -297452,8 +297456,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists all labels for an issue.

", "statusCodes": [ { "httpStatusCode": "200", @@ -297633,8 +297637,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Adds labels to an issue. If you provide an empty array of labels, all labels are removed from the issue.

", "statusCodes": [ { "httpStatusCode": "200", @@ -297899,8 +297903,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Removes all labels from an issue.

", "statusCodes": [ { "httpStatusCode": "204", @@ -298242,8 +298246,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists all labels for a repository.

", "statusCodes": [ { "httpStatusCode": "200", @@ -298403,8 +298407,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Creates a label for the specified repository with the given name and color. The name and color parameters are required. The color must be a valid hexadecimal color code.

", "statusCodes": [ { "httpStatusCode": "201", @@ -298552,8 +298556,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Gets a label using the given name.

", "statusCodes": [ { "httpStatusCode": "200", @@ -298722,8 +298726,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Updates a label using the given label name.

", "statusCodes": [ { "httpStatusCode": "200", @@ -298787,8 +298791,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Deletes a label using the given label name.

", "statusCodes": [ { "httpStatusCode": "204", @@ -298960,8 +298964,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists labels for issues in a milestone.

", "statusCodes": [ { "httpStatusCode": "200", @@ -299428,8 +299432,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists milestones for a repository.

", "statusCodes": [ { "httpStatusCode": "200", @@ -299870,8 +299874,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Creates a milestone.

", "statusCodes": [ { "httpStatusCode": "201", @@ -300288,8 +300292,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Gets a milestone using the given milestone number.

", "statusCodes": [ { "httpStatusCode": "200", @@ -300804,8 +300808,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Deletes a milestone using the given milestone number.

", "statusCodes": [ { "httpStatusCode": "204", @@ -316694,8 +316698,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

List all timeline events for an issue.

", "statusCodes": [ { "httpStatusCode": "200", @@ -317774,6 +317778,47 @@ "192.0.2.1" ] }, + "domains": { + "type": "object", + "properties": { + "website": { + "type": "array", + "items": { + "type": "string", + "examples": [ + "example.com" + ] + } + }, + "codespaces": { + "type": "array", + "items": { + "type": "string", + "examples": [ + "example.com" + ] + } + }, + "copilot": { + "type": "array", + "items": { + "type": "string", + "examples": [ + "example.com" + ] + } + }, + "packages": { + "type": "array", + "items": { + "type": "string", + "examples": [ + "example.com" + ] + } + } + } + }, "installed_version": { "type": "string", "examples": [ @@ -343656,8 +343701,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Check if the provided user is a public member of the organization.

", "statusCodes": [ { "httpStatusCode": "204", @@ -343774,8 +343819,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default.

", "statusCodes": [ { "httpStatusCode": "204", @@ -343824,7 +343869,7 @@ } ], "bodyParameters": [], - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", @@ -344254,8 +344299,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists all of the authenticated user's organization memberships.

", "statusCodes": [ { "httpStatusCode": "200", @@ -344298,7 +344343,7 @@ } ], "bodyParameters": [], - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", @@ -344686,8 +344731,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

If the authenticated user is an active or pending member of the organization, this endpoint will return the user's membership. If the authenticated user is not affiliated with the organization, a 404 is returned. This endpoint will return a 403 if the request is made by a GitHub App that is blocked by the organization.

", "statusCodes": [ { "httpStatusCode": "200", @@ -344733,7 +344778,7 @@ ] } ], - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", @@ -345125,8 +345170,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Converts the authenticated user to an active member of the organization, if that user has a pending invitation from the organization.

", "statusCodes": [ { "httpStatusCode": "200", @@ -353026,8 +353071,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists projects for a user.

", "statusCodes": [ { "httpStatusCode": "200", @@ -353373,8 +353418,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Gets information about a project card.

", "statusCodes": [ { "httpStatusCode": "200", @@ -353812,8 +353857,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Deletes a project card

", "statusCodes": [ { "httpStatusCode": "204", @@ -354298,8 +354343,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists the project cards in a project.

", "statusCodes": [ { "httpStatusCode": "200", @@ -355562,8 +355607,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Gets information about a project column.

", "statusCodes": [ { "httpStatusCode": "200", @@ -355775,8 +355820,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Deletes a project column.

", "statusCodes": [ { "httpStatusCode": "204", @@ -356018,8 +356063,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists the project columns in a project.

", "statusCodes": [ { "httpStatusCode": "200", @@ -356170,8 +356215,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Creates a new project column.

", "statusCodes": [ { "httpStatusCode": "201", @@ -426249,12 +426294,16 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists the teams that have access to the specified repository and that are also visible to the authenticated user.

\n

For a public repository, a team is listed only if that team added the public repository explicitly.

\n

Personal access tokens require the following scopes:

\n\n

This endpoint is not compatible with fine-grained personal access tokens.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" } ] }, diff --git a/src/rest/lib/config.json b/src/rest/lib/config.json index 62d5c9cb29..df6189efe1 100644 --- a/src/rest/lib/config.json +++ b/src/rest/lib/config.json @@ -30,5 +30,5 @@ ] } }, - "sha": "df7d66cbf0ce6e08a1f4183278f91e2ea679684c" + "sha": "5c1ef48b46e09d15bbc945937e7990af6d99c64b" } \ No newline at end of file diff --git a/src/webhooks/lib/config.json b/src/webhooks/lib/config.json index 4c68141183..87accc45e7 100644 --- a/src/webhooks/lib/config.json +++ b/src/webhooks/lib/config.json @@ -1,3 +1,3 @@ { - "sha": "df7d66cbf0ce6e08a1f4183278f91e2ea679684c" + "sha": "5c1ef48b46e09d15bbc945937e7990af6d99c64b" } \ No newline at end of file