From 75eea7686ea985f7efa03e2d1bc215dbcbc73adf Mon Sep 17 00:00:00 2001 From: docubot <67483024+docubot@users.noreply.github.com> Date: Thu, 11 May 2023 08:53:18 -0700 Subject: [PATCH] Update OpenAPI Description (#37010) Co-authored-by: Rachael Sewell --- src/github-apps/lib/config.json | 2 +- src/rest/data/fpt-2022-11-28/schema.json | 479 +++++++++++++++++---- src/rest/data/ghae/schema.json | 422 +++++++++++++++---- src/rest/data/ghec-2022-11-28/schema.json | 483 +++++++++++++++++----- src/rest/data/ghes-3.4/schema.json | 379 +++++++++++++---- src/rest/data/ghes-3.5/schema.json | 428 +++++++++++++++---- src/rest/data/ghes-3.6/schema.json | 428 +++++++++++++++---- src/rest/data/ghes-3.7/schema.json | 428 +++++++++++++++---- src/rest/data/ghes-3.8/schema.json | 477 +++++++++++++++++---- src/rest/lib/config.json | 2 +- src/webhooks/data/fpt/schema.json | 298 +++++++++---- src/webhooks/data/ghec/schema.json | 298 +++++++++---- src/webhooks/lib/config.json | 2 +- 13 files changed, 3298 insertions(+), 828 deletions(-) diff --git a/src/github-apps/lib/config.json b/src/github-apps/lib/config.json index 001ec6dd84..d05570740c 100644 --- a/src/github-apps/lib/config.json +++ b/src/github-apps/lib/config.json @@ -7,5 +7,5 @@ "2022-11-28" ] }, - "sha": "9ebe01d1bd3b3b323f2fbbf18f77b0c49f94c442" + "sha": "32e8e407fdb3957859a03ae38a6c0bd6513f3c7e" } \ 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 8726b579e7..c645527509 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", @@ -17941,7 +17941,7 @@ "description": "

Created

" } ], - "descriptionHTML": "

Returns a token that you can pass to the config script. The token expires after one hour.

\n

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

\n

Example using registration token #

\n

Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.

\n
./config.sh --url https://github.com/octo-org --token TOKEN\n
" + "descriptionHTML": "

Returns a token that you can pass to the config script. The token expires after one hour.

\n

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

\n

Example using registration token

\n

Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.

\n
./config.sh --url https://github.com/octo-org --token TOKEN\n
" }, { "serverUrl": "https://api.github.com", @@ -19516,7 +19516,7 @@ "description": "

Created

" } ], - "descriptionHTML": "

Returns a token that you can pass to the config script to remove a self-hosted runner from an organization. The token expires after one hour.

\n

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

\n

Example using remove token #

\n

To remove your self-hosted runner from an organization, replace TOKEN with the remove token provided by this\nendpoint.

\n
./config.sh remove --token TOKEN\n
" + "descriptionHTML": "

Returns a token that you can pass to the config script to remove a self-hosted runner from an organization. The token expires after one hour.

\n

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

\n

Example using remove token

\n

To remove your self-hosted runner from an organization, replace TOKEN with the remove token provided by this\nendpoint.

\n
./config.sh remove --token TOKEN\n
" }, { "serverUrl": "https://api.github.com", @@ -22352,7 +22352,7 @@ "description": "

Created

" } ], - "descriptionHTML": "

Returns a token that you can pass to the config script. The token expires after one hour. You must authenticate\nusing an access token with the repo scope to use this endpoint.

\n

Example using registration token #

\n

Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.

\n
./config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN\n
" + "descriptionHTML": "

Returns a token that you can pass to the config script. The token expires after one hour. You must authenticate\nusing an access token with the repo scope to use this endpoint.

\n

Example using registration token

\n

Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.

\n
./config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN\n
" }, { "serverUrl": "https://api.github.com", @@ -23937,7 +23937,7 @@ "description": "

Created

" } ], - "descriptionHTML": "

Returns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour.\nYou must authenticate using an access token with the repo scope to use this endpoint.

\n

Example using remove token #

\n

To remove your self-hosted runner from a repository, replace TOKEN with the remove token provided by this endpoint.

\n
./config.sh remove --token TOKEN\n
" + "descriptionHTML": "

Returns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour.\nYou must authenticate using an access token with the repo scope to use this endpoint.

\n

Example using remove token

\n

To remove your self-hosted runner from a repository, replace TOKEN with the remove token provided by this endpoint.

\n
./config.sh remove --token TOKEN\n
" }, { "serverUrl": "https://api.github.com", @@ -30485,29 +30485,52 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "description": "SHA for the commit", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] }, "tree_id": { - "type": "string" + "type": "string", + "description": "SHA for the commit's tree" }, "message": { - "type": "string" + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] }, "timestamp": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", - "format": "date-time" + "examples": [ + "2014-08-09T08:02:04+12:00" + ] }, "author": { "type": [ "object", "null" ], + "description": "Information about the Git author", "properties": { "name": { - "type": "string" + "description": "Name of the commit's author", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's author", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -30520,12 +30543,22 @@ "object", "null" ], + "description": "Information about the Git committer", "properties": { "name": { - "type": "string" + "description": "Name of the commit's committer", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's committer", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -33221,29 +33254,52 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "description": "SHA for the commit", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] }, "tree_id": { - "type": "string" + "type": "string", + "description": "SHA for the commit's tree" }, "message": { - "type": "string" + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] }, "timestamp": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", - "format": "date-time" + "examples": [ + "2014-08-09T08:02:04+12:00" + ] }, "author": { "type": [ "object", "null" ], + "description": "Information about the Git author", "properties": { "name": { - "type": "string" + "description": "Name of the commit's author", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's author", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -33256,12 +33312,22 @@ "object", "null" ], + "description": "Information about the Git committer", "properties": { "name": { - "type": "string" + "description": "Name of the commit's committer", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's committer", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -35872,29 +35938,52 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "description": "SHA for the commit", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] }, "tree_id": { - "type": "string" + "type": "string", + "description": "SHA for the commit's tree" }, "message": { - "type": "string" + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] }, "timestamp": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", - "format": "date-time" + "examples": [ + "2014-08-09T08:02:04+12:00" + ] }, "author": { "type": [ "object", "null" ], + "description": "Information about the Git author", "properties": { "name": { - "type": "string" + "description": "Name of the commit's author", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's author", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -35907,12 +35996,22 @@ "object", "null" ], + "description": "Information about the Git committer", "properties": { "name": { - "type": "string" + "description": "Name of the commit's committer", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's committer", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -39033,29 +39132,52 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "description": "SHA for the commit", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] }, "tree_id": { - "type": "string" + "type": "string", + "description": "SHA for the commit's tree" }, "message": { - "type": "string" + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] }, "timestamp": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", - "format": "date-time" + "examples": [ + "2014-08-09T08:02:04+12:00" + ] }, "author": { "type": [ "object", "null" ], + "description": "Information about the Git author", "properties": { "name": { - "type": "string" + "description": "Name of the commit's author", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's author", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -39068,12 +39190,22 @@ "object", "null" ], + "description": "Information about the Git committer", "properties": { "name": { - "type": "string" + "description": "Name of the commit's committer", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's committer", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -43925,29 +44057,52 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "description": "SHA for the commit", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] }, "tree_id": { - "type": "string" + "type": "string", + "description": "SHA for the commit's tree" }, "message": { - "type": "string" + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] }, "timestamp": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", - "format": "date-time" + "examples": [ + "2014-08-09T08:02:04+12:00" + ] }, "author": { "type": [ "object", "null" ], + "description": "Information about the Git author", "properties": { "name": { - "type": "string" + "description": "Name of the commit's author", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's author", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -43960,12 +44115,22 @@ "object", "null" ], + "description": "Information about the Git committer", "properties": { "name": { - "type": "string" + "description": "Name of the commit's committer", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's committer", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -150800,29 +150965,52 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "description": "SHA for the commit", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] }, "tree_id": { - "type": "string" + "type": "string", + "description": "SHA for the commit's tree" }, "message": { - "type": "string" + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] }, "timestamp": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", - "format": "date-time" + "examples": [ + "2014-08-09T08:02:04+12:00" + ] }, "author": { "type": [ "object", "null" ], + "description": "Information about the Git author", "properties": { "name": { - "type": "string" + "description": "Name of the commit's author", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's author", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -150835,12 +151023,22 @@ "object", "null" ], + "description": "Information about the Git committer", "properties": { "name": { - "type": "string" + "description": "Name of the commit's committer", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's committer", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -152547,29 +152745,52 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "description": "SHA for the commit", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] }, "tree_id": { - "type": "string" + "type": "string", + "description": "SHA for the commit's tree" }, "message": { - "type": "string" + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] }, "timestamp": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", - "format": "date-time" + "examples": [ + "2014-08-09T08:02:04+12:00" + ] }, "author": { "type": [ "object", "null" ], + "description": "Information about the Git author", "properties": { "name": { - "type": "string" + "description": "Name of the commit's author", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's author", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -152582,12 +152803,22 @@ "object", "null" ], + "description": "Information about the Git committer", "properties": { "name": { - "type": "string" + "description": "Name of the commit's committer", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's committer", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -155494,29 +155725,52 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "description": "SHA for the commit", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] }, "tree_id": { - "type": "string" + "type": "string", + "description": "SHA for the commit's tree" }, "message": { - "type": "string" + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] }, "timestamp": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", - "format": "date-time" + "examples": [ + "2014-08-09T08:02:04+12:00" + ] }, "author": { "type": [ "object", "null" ], + "description": "Information about the Git author", "properties": { "name": { - "type": "string" + "description": "Name of the commit's author", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's author", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -155529,12 +155783,22 @@ "object", "null" ], + "description": "Information about the Git committer", "properties": { "name": { - "type": "string" + "description": "Name of the commit's committer", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's committer", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -157294,29 +157558,52 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "description": "SHA for the commit", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] }, "tree_id": { - "type": "string" + "type": "string", + "description": "SHA for the commit's tree" }, "message": { - "type": "string" + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] }, "timestamp": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", - "format": "date-time" + "examples": [ + "2014-08-09T08:02:04+12:00" + ] }, "author": { "type": [ "object", "null" ], + "description": "Information about the Git author", "properties": { "name": { - "type": "string" + "description": "Name of the commit's author", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's author", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -157329,12 +157616,22 @@ "object", "null" ], + "description": "Information about the Git committer", "properties": { "name": { - "type": "string" + "description": "Name of the commit's committer", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's committer", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -192991,7 +193288,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", @@ -200843,7 +201140,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 write access to the codespaces_secrets\nrepository permission to use this endpoint.

\n

Example of 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 of 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 of 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 of 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 write access to the codespaces_secrets\nrepository permission to use this endpoint.

\n

Example of 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 of 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 of 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 of 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", @@ -201323,7 +201620,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", @@ -230274,7 +230571,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", @@ -231920,7 +232217,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", @@ -234922,7 +235219,7 @@ } ], "previews": [], - "descriptionHTML": "

Deployments offer a few configurable parameters with certain defaults.

\n

The ref parameter can be any named branch, tag, or SHA. At GitHub we often deploy branches and verify them\nbefore we merge a pull request.

\n

The environment parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as production, staging, and qa. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is production.

\n

The auto_merge parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref is behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.

\n

By default, commit statuses for every submitted context must be in a success\nstate. The required_contexts parameter allows you to specify a subset of contexts that must be success, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.

\n

The payload parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.

\n

The task parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe deploy:migrations to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.

\n

Users with repo or repo_deployment scopes can create a deployment for a given ref.

\n

Merged branch response #

\n

You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:

\n\n

If there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.

\n

Merge conflict response #

\n

This error happens when the auto_merge option is enabled and when the default branch (in this case master), can't\nbe merged into the branch that's being deployed (in this case topic-branch), due to merge conflicts.

\n

Failed commit status checks #

\n

This error happens when the required_contexts parameter indicates that one or more contexts need to have a success\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of success.

", + "descriptionHTML": "

Deployments offer a few configurable parameters with certain defaults.

\n

The ref parameter can be any named branch, tag, or SHA. At GitHub we often deploy branches and verify them\nbefore we merge a pull request.

\n

The environment parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as production, staging, and qa. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is production.

\n

The auto_merge parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref is behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.

\n

By default, commit statuses for every submitted context must be in a success\nstate. The required_contexts parameter allows you to specify a subset of contexts that must be success, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.

\n

The payload parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.

\n

The task parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe deploy:migrations to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.

\n

Users with repo or repo_deployment scopes can create a deployment for a given ref.

\n

Merged branch response

\n

You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:

\n\n

If there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.

\n

Merge conflict response

\n

This error happens when the auto_merge option is enabled and when the default branch (in this case master), can't\nbe merged into the branch that's being deployed (in this case topic-branch), due to merge conflicts.

\n

Failed commit status checks

\n

This error happens when the required_contexts parameter indicates that one or more contexts need to have a success\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of success.

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

Gets information about a GitHub Pages site.

\n

A token with the repo scope is required. GitHub Apps must have the pages:read permission.

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

Lists builts of a GitHub Pages site.

\n

A token with the repo scope is required. GitHub Apps must have the pages:read permission.

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

Gets information about the single most recent build of a GitHub Pages site.

\n

A token with the repo scope is required. GitHub Apps must have the pages:read permission.

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

Gets information about a GitHub Pages build.

\n

A token with the repo scope is required. GitHub Apps must have the pages:read permission.

", "statusCodes": [ { "httpStatusCode": "200", @@ -477351,7 +477648,7 @@ } ], "previews": [], - "descriptionHTML": "

Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.

\n

Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.

\n

Notes:

\n\n

Size limits #

\n

If the requested file's size is:

\n\n

If the content is a directory #

\n

The response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".

\n

If the content is a symlink #

\n

If the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.

\n

If the content is a submodule #

\n

The submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.

\n

If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.

", + "descriptionHTML": "

Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.

\n

Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.

\n

Notes:

\n\n

Size limits

\n

If the requested file's size is:

\n\n

If the content is a directory

\n

The response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".

\n

If the content is a symlink

\n

If the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.

\n

If the content is a submodule

\n

The submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.

\n

If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.

", "statusCodes": [ { "httpStatusCode": "200", @@ -492691,7 +492988,7 @@ } ], "previews": [], - "descriptionHTML": "

Searches for query terms inside of a file. This method returns up to 100 results per page.

\n

When searching for code, you can get text match metadata for the file content and file path fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

\n

For example, if you want to find the definition of the addClass function inside jQuery repository, your query would look something like this:

\n

q=addClass+in:file+language:js+repo:jquery/jquery

\n

This query searches for the keyword addClass within a file's contents. The query limits the search to files where the language is JavaScript in the jquery/jquery repository.

\n

Considerations for code search #

\n

Due to the complexity of searching code, there are a few restrictions on how searches are performed:

\n\n

This endpoint requires you to authenticate and limits you to 10 requests per minute.

", + "descriptionHTML": "

Searches for query terms inside of a file. This method returns up to 100 results per page.

\n

When searching for code, you can get text match metadata for the file content and file path fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

\n

For example, if you want to find the definition of the addClass function inside jQuery repository, your query would look something like this:

\n

q=addClass+in:file+language:js+repo:jquery/jquery

\n

This query searches for the keyword addClass within a file's contents. The query limits the search to files where the language is JavaScript in the jquery/jquery repository.

\n

Considerations for code search

\n

Due to the complexity of searching code, there are a few restrictions on how searches are performed:

\n\n

This endpoint requires you to authenticate and limits you to 10 requests per minute.

", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/data/ghae/schema.json b/src/rest/data/ghae/schema.json index bb813dc706..f0af9f203f 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", @@ -10175,7 +10175,7 @@ "description": "

Created

" } ], - "descriptionHTML": "

Returns a token that you can pass to the config script. The token expires after one hour.

\n

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

\n

Example using registration token #

\n

Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.

\n
./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n
" + "descriptionHTML": "

Returns a token that you can pass to the config script. The token expires after one hour.

\n

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

\n

Example using registration token

\n

Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.

\n
./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n
" }, { "serverUrl": "https://HOSTNAME/api/v3", @@ -11665,7 +11665,7 @@ "description": "

Created

" } ], - "descriptionHTML": "

Returns a token that you can pass to the config script to remove a self-hosted runner from an enterprise. The token expires after one hour.

\n

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

\n

Example using remove token #

\n

To remove your self-hosted runner from an enterprise, replace TOKEN with the remove token provided by this\nendpoint.

\n
./config.sh remove --token TOKEN\n
" + "descriptionHTML": "

Returns a token that you can pass to the config script to remove a self-hosted runner from an enterprise. The token expires after one hour.

\n

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

\n

Example using remove token

\n

To remove your self-hosted runner from an enterprise, replace TOKEN with the remove token provided by this\nendpoint.

\n
./config.sh remove --token TOKEN\n
" }, { "serverUrl": "https://HOSTNAME/api/v3", @@ -13709,7 +13709,7 @@ "description": "

Created

" } ], - "descriptionHTML": "

Returns a token that you can pass to the config script. The token expires after one hour.

\n

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

\n

Example using registration token #

\n

Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.

\n
./config.sh --url https://github.com/octo-org --token TOKEN\n
" + "descriptionHTML": "

Returns a token that you can pass to the config script. The token expires after one hour.

\n

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

\n

Example using registration token

\n

Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.

\n
./config.sh --url https://github.com/octo-org --token TOKEN\n
" }, { "serverUrl": "https://HOSTNAME/api/v3", @@ -15199,7 +15199,7 @@ "description": "

Created

" } ], - "descriptionHTML": "

Returns a token that you can pass to the config script to remove a self-hosted runner from an organization. The token expires after one hour.

\n

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

\n

Example using remove token #

\n

To remove your self-hosted runner from an organization, replace TOKEN with the remove token provided by this\nendpoint.

\n
./config.sh remove --token TOKEN\n
" + "descriptionHTML": "

Returns a token that you can pass to the config script to remove a self-hosted runner from an organization. The token expires after one hour.

\n

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

\n

Example using remove token

\n

To remove your self-hosted runner from an organization, replace TOKEN with the remove token provided by this\nendpoint.

\n
./config.sh remove --token TOKEN\n
" }, { "serverUrl": "https://HOSTNAME/api/v3", @@ -17273,7 +17273,7 @@ "description": "

Created

" } ], - "descriptionHTML": "

Returns a token that you can pass to the config script. The token expires after one hour. You must authenticate\nusing an access token with the repo scope to use this endpoint.

\n

Example using registration token #

\n

Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.

\n
./config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN\n
" + "descriptionHTML": "

Returns a token that you can pass to the config script. The token expires after one hour. You must authenticate\nusing an access token with the repo scope to use this endpoint.

\n

Example using registration token

\n

Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.

\n
./config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN\n
" }, { "serverUrl": "https://HOSTNAME/api/v3", @@ -18773,7 +18773,7 @@ "description": "

Created

" } ], - "descriptionHTML": "

Returns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour.\nYou must authenticate using an access token with the repo scope to use this endpoint.

\n

Example using remove token #

\n

To remove your self-hosted runner from a repository, replace TOKEN with the remove token provided by this endpoint.

\n
./config.sh remove --token TOKEN\n
" + "descriptionHTML": "

Returns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour.\nYou must authenticate using an access token with the repo scope to use this endpoint.

\n

Example using remove token

\n

To remove your self-hosted runner from a repository, replace TOKEN with the remove token provided by this endpoint.

\n
./config.sh remove --token TOKEN\n
" }, { "serverUrl": "https://HOSTNAME/api/v3", @@ -21626,29 +21626,52 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "description": "SHA for the commit", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] }, "tree_id": { - "type": "string" + "type": "string", + "description": "SHA for the commit's tree" }, "message": { - "type": "string" + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] }, "timestamp": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", - "format": "date-time" + "examples": [ + "2014-08-09T08:02:04+12:00" + ] }, "author": { "type": [ "object", "null" ], + "description": "Information about the Git author", "properties": { "name": { - "type": "string" + "description": "Name of the commit's author", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's author", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -21661,12 +21684,22 @@ "object", "null" ], + "description": "Information about the Git committer", "properties": { "name": { - "type": "string" + "description": "Name of the commit's committer", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's committer", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -24277,29 +24310,52 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "description": "SHA for the commit", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] }, "tree_id": { - "type": "string" + "type": "string", + "description": "SHA for the commit's tree" }, "message": { - "type": "string" + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] }, "timestamp": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", - "format": "date-time" + "examples": [ + "2014-08-09T08:02:04+12:00" + ] }, "author": { "type": [ "object", "null" ], + "description": "Information about the Git author", "properties": { "name": { - "type": "string" + "description": "Name of the commit's author", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's author", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -24312,12 +24368,22 @@ "object", "null" ], + "description": "Information about the Git committer", "properties": { "name": { - "type": "string" + "description": "Name of the commit's committer", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's committer", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -27000,29 +27066,52 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "description": "SHA for the commit", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] }, "tree_id": { - "type": "string" + "type": "string", + "description": "SHA for the commit's tree" }, "message": { - "type": "string" + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] }, "timestamp": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", - "format": "date-time" + "examples": [ + "2014-08-09T08:02:04+12:00" + ] }, "author": { "type": [ "object", "null" ], + "description": "Information about the Git author", "properties": { "name": { - "type": "string" + "description": "Name of the commit's author", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's author", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -27035,12 +27124,22 @@ "object", "null" ], + "description": "Information about the Git committer", "properties": { "name": { - "type": "string" + "description": "Name of the commit's committer", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's committer", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -30351,29 +30450,52 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "description": "SHA for the commit", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] }, "tree_id": { - "type": "string" + "type": "string", + "description": "SHA for the commit's tree" }, "message": { - "type": "string" + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] }, "timestamp": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", - "format": "date-time" + "examples": [ + "2014-08-09T08:02:04+12:00" + ] }, "author": { "type": [ "object", "null" ], + "description": "Information about the Git author", "properties": { "name": { - "type": "string" + "description": "Name of the commit's author", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's author", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -30386,12 +30508,22 @@ "object", "null" ], + "description": "Information about the Git committer", "properties": { "name": { - "type": "string" + "description": "Name of the commit's committer", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's committer", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -105060,29 +105192,52 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "description": "SHA for the commit", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] }, "tree_id": { - "type": "string" + "type": "string", + "description": "SHA for the commit's tree" }, "message": { - "type": "string" + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] }, "timestamp": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", - "format": "date-time" + "examples": [ + "2014-08-09T08:02:04+12:00" + ] }, "author": { "type": [ "object", "null" ], + "description": "Information about the Git author", "properties": { "name": { - "type": "string" + "description": "Name of the commit's author", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's author", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -105095,12 +105250,22 @@ "object", "null" ], + "description": "Information about the Git committer", "properties": { "name": { - "type": "string" + "description": "Name of the commit's committer", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's committer", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -106807,29 +106972,52 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "description": "SHA for the commit", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] }, "tree_id": { - "type": "string" + "type": "string", + "description": "SHA for the commit's tree" }, "message": { - "type": "string" + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] }, "timestamp": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", - "format": "date-time" + "examples": [ + "2014-08-09T08:02:04+12:00" + ] }, "author": { "type": [ "object", "null" ], + "description": "Information about the Git author", "properties": { "name": { - "type": "string" + "description": "Name of the commit's author", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's author", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -106842,12 +107030,22 @@ "object", "null" ], + "description": "Information about the Git committer", "properties": { "name": { - "type": "string" + "description": "Name of the commit's committer", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's committer", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -109754,29 +109952,52 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "description": "SHA for the commit", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] }, "tree_id": { - "type": "string" + "type": "string", + "description": "SHA for the commit's tree" }, "message": { - "type": "string" + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] }, "timestamp": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", - "format": "date-time" + "examples": [ + "2014-08-09T08:02:04+12:00" + ] }, "author": { "type": [ "object", "null" ], + "description": "Information about the Git author", "properties": { "name": { - "type": "string" + "description": "Name of the commit's author", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's author", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -109789,12 +110010,22 @@ "object", "null" ], + "description": "Information about the Git committer", "properties": { "name": { - "type": "string" + "description": "Name of the commit's committer", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's committer", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -111554,29 +111785,52 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "description": "SHA for the commit", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] }, "tree_id": { - "type": "string" + "type": "string", + "description": "SHA for the commit's tree" }, "message": { - "type": "string" + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] }, "timestamp": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", - "format": "date-time" + "examples": [ + "2014-08-09T08:02:04+12:00" + ] }, "author": { "type": [ "object", "null" ], + "description": "Information about the Git author", "properties": { "name": { - "type": "string" + "description": "Name of the commit's author", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's author", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -111589,12 +111843,22 @@ "object", "null" ], + "description": "Information about the Git committer", "properties": { "name": { - "type": "string" + "description": "Name of the commit's committer", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's committer", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -138923,7 +139187,7 @@ } ], "previews": [], - "descriptionHTML": "

Deployments offer a few configurable parameters with certain defaults.

\n

The ref parameter can be any named branch, tag, or SHA. At GitHub AE we often deploy branches and verify them\nbefore we merge a pull request.

\n

The environment parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as production, staging, and qa. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is production.

\n

The auto_merge parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref is behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.

\n

By default, commit statuses for every submitted context must be in a success\nstate. The required_contexts parameter allows you to specify a subset of contexts that must be success, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.

\n

The payload parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.

\n

The task parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe deploy:migrations to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.

\n

Users with repo or repo_deployment scopes can create a deployment for a given ref.

\n

Merged branch response #

\n

You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:

\n\n

If there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.

\n

Merge conflict response #

\n

This error happens when the auto_merge option is enabled and when the default branch (in this case master), can't\nbe merged into the branch that's being deployed (in this case topic-branch), due to merge conflicts.

\n

Failed commit status checks #

\n

This error happens when the required_contexts parameter indicates that one or more contexts need to have a success\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of success.

", + "descriptionHTML": "

Deployments offer a few configurable parameters with certain defaults.

\n

The ref parameter can be any named branch, tag, or SHA. At GitHub AE we often deploy branches and verify them\nbefore we merge a pull request.

\n

The environment parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as production, staging, and qa. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is production.

\n

The auto_merge parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref is behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.

\n

By default, commit statuses for every submitted context must be in a success\nstate. The required_contexts parameter allows you to specify a subset of contexts that must be success, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.

\n

The payload parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.

\n

The task parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe deploy:migrations to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.

\n

Users with repo or repo_deployment scopes can create a deployment for a given ref.

\n

Merged branch response

\n

You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:

\n\n

If there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.

\n

Merge conflict response

\n

This error happens when the auto_merge option is enabled and when the default branch (in this case master), can't\nbe merged into the branch that's being deployed (in this case topic-branch), due to merge conflicts.

\n

Failed commit status checks

\n

This error happens when the required_contexts parameter indicates that one or more contexts need to have a success\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of success.

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

Gets information about a GitHub AE Pages site.

\n

A token with the repo scope is required. GitHub Apps must have the pages:read permission.

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

Lists builts of a GitHub AE Pages site.

\n

A token with the repo scope is required. GitHub Apps must have the pages:read permission.

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

Gets information about the single most recent build of a GitHub AE Pages site.

\n

A token with the repo scope is required. GitHub Apps must have the pages:read permission.

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

Gets information about a GitHub AE Pages build.

\n

A token with the repo scope is required. GitHub Apps must have the pages:read permission.

", "statusCodes": [ { "httpStatusCode": "200", @@ -351483,7 +351747,7 @@ } ], "previews": [], - "descriptionHTML": "

Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.

\n

Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.

\n

Notes:

\n\n

If the content is a directory #

\n

The response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".

\n

If the content is a symlink #

\n

If the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.

\n

If the content is a submodule #

\n

The submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.

\n

If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.

", + "descriptionHTML": "

Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.

\n

Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.

\n

Notes:

\n\n

If the content is a directory

\n

The response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".

\n

If the content is a symlink

\n

If the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.

\n

If the content is a submodule

\n

The submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.

\n

If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.

", "statusCodes": [ { "httpStatusCode": "200", @@ -361104,7 +361368,7 @@ } ], "previews": [], - "descriptionHTML": "

Searches for query terms inside of a file. This method returns up to 100 results per page.

\n

When searching for code, you can get text match metadata for the file content and file path fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

\n

For example, if you want to find the definition of the addClass function inside jQuery repository, your query would look something like this:

\n

q=addClass+in:file+language:js+repo:jquery/jquery

\n

This query searches for the keyword addClass within a file's contents. The query limits the search to files where the language is JavaScript in the jquery/jquery repository.

\n

Considerations for code search #

\n

Due to the complexity of searching code, there are a few restrictions on how searches are performed:

\n\n

This endpoint requires you to authenticate and limits you to 10 requests per minute.

", + "descriptionHTML": "

Searches for query terms inside of a file. This method returns up to 100 results per page.

\n

When searching for code, you can get text match metadata for the file content and file path fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

\n

For example, if you want to find the definition of the addClass function inside jQuery repository, your query would look something like this:

\n

q=addClass+in:file+language:js+repo:jquery/jquery

\n

This query searches for the keyword addClass within a file's contents. The query limits the search to files where the language is JavaScript in the jquery/jquery repository.

\n

Considerations for code search

\n

Due to the complexity of searching code, there are a few restrictions on how searches are performed:

\n\n

This endpoint requires you to authenticate and limits you to 10 requests per minute.

", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/data/ghec-2022-11-28/schema.json b/src/rest/data/ghec-2022-11-28/schema.json index 8127f7156a..477d385659 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", @@ -22934,7 +22934,7 @@ "description": "

Created

" } ], - "descriptionHTML": "

Returns a token that you can pass to the config script. The token expires after one hour.

\n

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

\n

Example using registration token #

\n

Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.

\n
./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n
" + "descriptionHTML": "

Returns a token that you can pass to the config script. The token expires after one hour.

\n

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

\n

Example using registration token

\n

Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.

\n
./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n
" }, { "serverUrl": "https://api.github.com", @@ -24509,7 +24509,7 @@ "description": "

Created

" } ], - "descriptionHTML": "

Returns a token that you can pass to the config script to remove a self-hosted runner from an enterprise. The token expires after one hour.

\n

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

\n

Example using remove token #

\n

To remove your self-hosted runner from an enterprise, replace TOKEN with the remove token provided by this\nendpoint.

\n
./config.sh remove --token TOKEN\n
" + "descriptionHTML": "

Returns a token that you can pass to the config script to remove a self-hosted runner from an enterprise. The token expires after one hour.

\n

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

\n

Example using remove token

\n

To remove your self-hosted runner from an enterprise, replace TOKEN with the remove token provided by this\nendpoint.

\n
./config.sh remove --token TOKEN\n
" }, { "serverUrl": "https://api.github.com", @@ -27319,7 +27319,7 @@ "description": "

Created

" } ], - "descriptionHTML": "

Returns a token that you can pass to the config script. The token expires after one hour.

\n

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

\n

Example using registration token #

\n

Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.

\n
./config.sh --url https://github.com/octo-org --token TOKEN\n
" + "descriptionHTML": "

Returns a token that you can pass to the config script. The token expires after one hour.

\n

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

\n

Example using registration token

\n

Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.

\n
./config.sh --url https://github.com/octo-org --token TOKEN\n
" }, { "serverUrl": "https://api.github.com", @@ -28894,7 +28894,7 @@ "description": "

Created

" } ], - "descriptionHTML": "

Returns a token that you can pass to the config script to remove a self-hosted runner from an organization. The token expires after one hour.

\n

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

\n

Example using remove token #

\n

To remove your self-hosted runner from an organization, replace TOKEN with the remove token provided by this\nendpoint.

\n
./config.sh remove --token TOKEN\n
" + "descriptionHTML": "

Returns a token that you can pass to the config script to remove a self-hosted runner from an organization. The token expires after one hour.

\n

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

\n

Example using remove token

\n

To remove your self-hosted runner from an organization, replace TOKEN with the remove token provided by this\nendpoint.

\n
./config.sh remove --token TOKEN\n
" }, { "serverUrl": "https://api.github.com", @@ -31730,7 +31730,7 @@ "description": "

Created

" } ], - "descriptionHTML": "

Returns a token that you can pass to the config script. The token expires after one hour. You must authenticate\nusing an access token with the repo scope to use this endpoint.

\n

Example using registration token #

\n

Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.

\n
./config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN\n
" + "descriptionHTML": "

Returns a token that you can pass to the config script. The token expires after one hour. You must authenticate\nusing an access token with the repo scope to use this endpoint.

\n

Example using registration token

\n

Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.

\n
./config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN\n
" }, { "serverUrl": "https://api.github.com", @@ -33315,7 +33315,7 @@ "description": "

Created

" } ], - "descriptionHTML": "

Returns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour.\nYou must authenticate using an access token with the repo scope to use this endpoint.

\n

Example using remove token #

\n

To remove your self-hosted runner from a repository, replace TOKEN with the remove token provided by this endpoint.

\n
./config.sh remove --token TOKEN\n
" + "descriptionHTML": "

Returns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour.\nYou must authenticate using an access token with the repo scope to use this endpoint.

\n

Example using remove token

\n

To remove your self-hosted runner from a repository, replace TOKEN with the remove token provided by this endpoint.

\n
./config.sh remove --token TOKEN\n
" }, { "serverUrl": "https://api.github.com", @@ -39863,29 +39863,52 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "description": "SHA for the commit", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] }, "tree_id": { - "type": "string" + "type": "string", + "description": "SHA for the commit's tree" }, "message": { - "type": "string" + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] }, "timestamp": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", - "format": "date-time" + "examples": [ + "2014-08-09T08:02:04+12:00" + ] }, "author": { "type": [ "object", "null" ], + "description": "Information about the Git author", "properties": { "name": { - "type": "string" + "description": "Name of the commit's author", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's author", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -39898,12 +39921,22 @@ "object", "null" ], + "description": "Information about the Git committer", "properties": { "name": { - "type": "string" + "description": "Name of the commit's committer", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's committer", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -42599,29 +42632,52 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "description": "SHA for the commit", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] }, "tree_id": { - "type": "string" + "type": "string", + "description": "SHA for the commit's tree" }, "message": { - "type": "string" + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] }, "timestamp": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", - "format": "date-time" + "examples": [ + "2014-08-09T08:02:04+12:00" + ] }, "author": { "type": [ "object", "null" ], + "description": "Information about the Git author", "properties": { "name": { - "type": "string" + "description": "Name of the commit's author", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's author", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -42634,12 +42690,22 @@ "object", "null" ], + "description": "Information about the Git committer", "properties": { "name": { - "type": "string" + "description": "Name of the commit's committer", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's committer", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -45250,29 +45316,52 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "description": "SHA for the commit", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] }, "tree_id": { - "type": "string" + "type": "string", + "description": "SHA for the commit's tree" }, "message": { - "type": "string" + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] }, "timestamp": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", - "format": "date-time" + "examples": [ + "2014-08-09T08:02:04+12:00" + ] }, "author": { "type": [ "object", "null" ], + "description": "Information about the Git author", "properties": { "name": { - "type": "string" + "description": "Name of the commit's author", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's author", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -45285,12 +45374,22 @@ "object", "null" ], + "description": "Information about the Git committer", "properties": { "name": { - "type": "string" + "description": "Name of the commit's committer", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's committer", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -48411,29 +48510,52 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "description": "SHA for the commit", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] }, "tree_id": { - "type": "string" + "type": "string", + "description": "SHA for the commit's tree" }, "message": { - "type": "string" + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] }, "timestamp": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", - "format": "date-time" + "examples": [ + "2014-08-09T08:02:04+12:00" + ] }, "author": { "type": [ "object", "null" ], + "description": "Information about the Git author", "properties": { "name": { - "type": "string" + "description": "Name of the commit's author", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's author", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -48446,12 +48568,22 @@ "object", "null" ], + "description": "Information about the Git committer", "properties": { "name": { - "type": "string" + "description": "Name of the commit's committer", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's committer", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -53303,29 +53435,52 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "description": "SHA for the commit", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] }, "tree_id": { - "type": "string" + "type": "string", + "description": "SHA for the commit's tree" }, "message": { - "type": "string" + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] }, "timestamp": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", - "format": "date-time" + "examples": [ + "2014-08-09T08:02:04+12:00" + ] }, "author": { "type": [ "object", "null" ], + "description": "Information about the Git author", "properties": { "name": { - "type": "string" + "description": "Name of the commit's author", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's author", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -53338,12 +53493,22 @@ "object", "null" ], + "description": "Information about the Git committer", "properties": { "name": { - "type": "string" + "description": "Name of the commit's committer", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's committer", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -160858,29 +161023,52 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "description": "SHA for the commit", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] }, "tree_id": { - "type": "string" + "type": "string", + "description": "SHA for the commit's tree" }, "message": { - "type": "string" + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] }, "timestamp": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", - "format": "date-time" + "examples": [ + "2014-08-09T08:02:04+12:00" + ] }, "author": { "type": [ "object", "null" ], + "description": "Information about the Git author", "properties": { "name": { - "type": "string" + "description": "Name of the commit's author", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's author", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -160893,12 +161081,22 @@ "object", "null" ], + "description": "Information about the Git committer", "properties": { "name": { - "type": "string" + "description": "Name of the commit's committer", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's committer", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -162605,29 +162803,52 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "description": "SHA for the commit", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] }, "tree_id": { - "type": "string" + "type": "string", + "description": "SHA for the commit's tree" }, "message": { - "type": "string" + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] }, "timestamp": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", - "format": "date-time" + "examples": [ + "2014-08-09T08:02:04+12:00" + ] }, "author": { "type": [ "object", "null" ], + "description": "Information about the Git author", "properties": { "name": { - "type": "string" + "description": "Name of the commit's author", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's author", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -162640,12 +162861,22 @@ "object", "null" ], + "description": "Information about the Git committer", "properties": { "name": { - "type": "string" + "description": "Name of the commit's committer", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's committer", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -165552,29 +165783,52 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "description": "SHA for the commit", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] }, "tree_id": { - "type": "string" + "type": "string", + "description": "SHA for the commit's tree" }, "message": { - "type": "string" + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] }, "timestamp": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", - "format": "date-time" + "examples": [ + "2014-08-09T08:02:04+12:00" + ] }, "author": { "type": [ "object", "null" ], + "description": "Information about the Git author", "properties": { "name": { - "type": "string" + "description": "Name of the commit's author", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's author", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -165587,12 +165841,22 @@ "object", "null" ], + "description": "Information about the Git committer", "properties": { "name": { - "type": "string" + "description": "Name of the commit's committer", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's committer", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -167352,29 +167616,52 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "description": "SHA for the commit", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] }, "tree_id": { - "type": "string" + "type": "string", + "description": "SHA for the commit's tree" }, "message": { - "type": "string" + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] }, "timestamp": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", - "format": "date-time" + "examples": [ + "2014-08-09T08:02:04+12:00" + ] }, "author": { "type": [ "object", "null" ], + "description": "Information about the Git author", "properties": { "name": { - "type": "string" + "description": "Name of the commit's author", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's author", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -167387,12 +167674,22 @@ "object", "null" ], + "description": "Information about the Git committer", "properties": { "name": { - "type": "string" + "description": "Name of the commit's committer", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's committer", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -204456,7 +204753,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", @@ -212308,7 +212605,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 write access to the codespaces_secrets\nrepository permission to use this endpoint.

\n

Example of 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 of 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 of 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 of 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 write access to the codespaces_secrets\nrepository permission to use this endpoint.

\n

Example of 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 of 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 of 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 of 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", @@ -212788,7 +213085,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", @@ -241739,7 +242036,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", @@ -243385,7 +243682,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", @@ -246387,7 +246684,7 @@ } ], "previews": [], - "descriptionHTML": "

Deployments offer a few configurable parameters with certain defaults.

\n

The ref parameter can be any named branch, tag, or SHA. At GitHub Enterprise Cloud we often deploy branches and verify them\nbefore we merge a pull request.

\n

The environment parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as production, staging, and qa. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is production.

\n

The auto_merge parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref is behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.

\n

By default, commit statuses for every submitted context must be in a success\nstate. The required_contexts parameter allows you to specify a subset of contexts that must be success, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.

\n

The payload parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.

\n

The task parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe deploy:migrations to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.

\n

Users with repo or repo_deployment scopes can create a deployment for a given ref.

\n

Merged branch response #

\n

You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:

\n\n

If there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.

\n

Merge conflict response #

\n

This error happens when the auto_merge option is enabled and when the default branch (in this case master), can't\nbe merged into the branch that's being deployed (in this case topic-branch), due to merge conflicts.

\n

Failed commit status checks #

\n

This error happens when the required_contexts parameter indicates that one or more contexts need to have a success\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of success.

", + "descriptionHTML": "

Deployments offer a few configurable parameters with certain defaults.

\n

The ref parameter can be any named branch, tag, or SHA. At GitHub Enterprise Cloud we often deploy branches and verify them\nbefore we merge a pull request.

\n

The environment parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as production, staging, and qa. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is production.

\n

The auto_merge parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref is behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.

\n

By default, commit statuses for every submitted context must be in a success\nstate. The required_contexts parameter allows you to specify a subset of contexts that must be success, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.

\n

The payload parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.

\n

The task parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe deploy:migrations to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.

\n

Users with repo or repo_deployment scopes can create a deployment for a given ref.

\n

Merged branch response

\n

You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:

\n\n

If there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.

\n

Merge conflict response

\n

This error happens when the auto_merge option is enabled and when the default branch (in this case master), can't\nbe merged into the branch that's being deployed (in this case topic-branch), due to merge conflicts.

\n

Failed commit status checks

\n

This error happens when the required_contexts parameter indicates that one or more contexts need to have a success\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of success.

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

Gets information about a GitHub Enterprise Cloud Pages site.

\n

A token with the repo scope is required. GitHub Apps must have the pages:read permission.

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

Lists builts of a GitHub Enterprise Cloud Pages site.

\n

A token with the repo scope is required. GitHub Apps must have the pages:read permission.

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

Gets information about the single most recent build of a GitHub Enterprise Cloud Pages site.

\n

A token with the repo scope is required. GitHub Apps must have the pages:read permission.

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

Gets information about a GitHub Enterprise Cloud Pages build.

\n

A token with the repo scope is required. GitHub Apps must have the pages:read permission.

", "statusCodes": [ { "httpStatusCode": "200", @@ -494102,7 +494399,7 @@ } ], "previews": [], - "descriptionHTML": "

Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.

\n

Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.

\n

Notes:

\n\n

Size limits #

\n

If the requested file's size is:

\n\n

If the content is a directory #

\n

The response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".

\n

If the content is a symlink #

\n

If the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.

\n

If the content is a submodule #

\n

The submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.

\n

If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.

", + "descriptionHTML": "

Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.

\n

Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.

\n

Notes:

\n\n

Size limits

\n

If the requested file's size is:

\n\n

If the content is a directory

\n

The response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".

\n

If the content is a symlink

\n

If the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.

\n

If the content is a submodule

\n

The submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.

\n

If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.

", "statusCodes": [ { "httpStatusCode": "200", @@ -511928,7 +512225,7 @@ } ], "previews": [], - "descriptionHTML": "

Searches for query terms inside of a file. This method returns up to 100 results per page.

\n

When searching for code, you can get text match metadata for the file content and file path fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

\n

For example, if you want to find the definition of the addClass function inside jQuery repository, your query would look something like this:

\n

q=addClass+in:file+language:js+repo:jquery/jquery

\n

This query searches for the keyword addClass within a file's contents. The query limits the search to files where the language is JavaScript in the jquery/jquery repository.

\n

Considerations for code search #

\n

Due to the complexity of searching code, there are a few restrictions on how searches are performed:

\n\n

This endpoint requires you to authenticate and limits you to 10 requests per minute.

", + "descriptionHTML": "

Searches for query terms inside of a file. This method returns up to 100 results per page.

\n

When searching for code, you can get text match metadata for the file content and file path fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

\n

For example, if you want to find the definition of the addClass function inside jQuery repository, your query would look something like this:

\n

q=addClass+in:file+language:js+repo:jquery/jquery

\n

This query searches for the keyword addClass within a file's contents. The query limits the search to files where the language is JavaScript in the jquery/jquery repository.

\n

Considerations for code search

\n

Due to the complexity of searching code, there are a few restrictions on how searches are performed:

\n\n

This endpoint requires you to authenticate and limits you to 10 requests per minute.

", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/data/ghes-3.4/schema.json b/src/rest/data/ghes-3.4/schema.json index 9852f5ec67..f5973dd9c3 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", @@ -12188,7 +12188,7 @@ "description": "

Created

" } ], - "descriptionHTML": "

Returns a token that you can pass to the config script. The token expires after one hour.

\n

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

\n

Example using registration token #

\n

Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.

\n
./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n
" + "descriptionHTML": "

Returns a token that you can pass to the config script. The token expires after one hour.

\n

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

\n

Example using registration token

\n

Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.

\n
./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -13673,7 +13673,7 @@ "description": "

Created

" } ], - "descriptionHTML": "

Returns a token that you can pass to the config script to remove a self-hosted runner from an enterprise. The token expires after one hour.

\n

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

\n

Example using remove token #

\n

To remove your self-hosted runner from an enterprise, replace TOKEN with the remove token provided by this\nendpoint.

\n
./config.sh remove --token TOKEN\n
" + "descriptionHTML": "

Returns a token that you can pass to the config script to remove a self-hosted runner from an enterprise. The token expires after one hour.

\n

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

\n

Example using remove token

\n

To remove your self-hosted runner from an enterprise, replace TOKEN with the remove token provided by this\nendpoint.

\n
./config.sh remove --token TOKEN\n
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -16403,7 +16403,7 @@ "description": "

Created

" } ], - "descriptionHTML": "

Returns a token that you can pass to the config script. The token expires after one hour.

\n

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

\n

Example using registration token #

\n

Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.

\n
./config.sh --url https://github.com/octo-org --token TOKEN\n
" + "descriptionHTML": "

Returns a token that you can pass to the config script. The token expires after one hour.

\n

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

\n

Example using registration token

\n

Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.

\n
./config.sh --url https://github.com/octo-org --token TOKEN\n
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -17888,7 +17888,7 @@ "description": "

Created

" } ], - "descriptionHTML": "

Returns a token that you can pass to the config script to remove a self-hosted runner from an organization. The token expires after one hour.

\n

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

\n

Example using remove token #

\n

To remove your self-hosted runner from an organization, replace TOKEN with the remove token provided by this\nendpoint.

\n
./config.sh remove --token TOKEN\n
" + "descriptionHTML": "

Returns a token that you can pass to the config script to remove a self-hosted runner from an organization. The token expires after one hour.

\n

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

\n

Example using remove token

\n

To remove your self-hosted runner from an organization, replace TOKEN with the remove token provided by this\nendpoint.

\n
./config.sh remove --token TOKEN\n
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -20644,7 +20644,7 @@ "description": "

Created

" } ], - "descriptionHTML": "

Returns a token that you can pass to the config script. The token expires after one hour. You must authenticate\nusing an access token with the repo scope to use this endpoint.

\n

Example using registration token #

\n

Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.

\n
./config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN\n
" + "descriptionHTML": "

Returns a token that you can pass to the config script. The token expires after one hour. You must authenticate\nusing an access token with the repo scope to use this endpoint.

\n

Example using registration token

\n

Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.

\n
./config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN\n
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -22139,7 +22139,7 @@ "description": "

Created

" } ], - "descriptionHTML": "

Returns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour.\nYou must authenticate using an access token with the repo scope to use this endpoint.

\n

Example using remove token #

\n

To remove your self-hosted runner from a repository, replace TOKEN with the remove token provided by this endpoint.

\n
./config.sh remove --token TOKEN\n
" + "descriptionHTML": "

Returns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour.\nYou must authenticate using an access token with the repo scope to use this endpoint.

\n

Example using remove token

\n

To remove your self-hosted runner from a repository, replace TOKEN with the remove token provided by this endpoint.

\n
./config.sh remove --token TOKEN\n
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -24721,29 +24721,52 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "description": "SHA for the commit", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] }, "tree_id": { - "type": "string" + "type": "string", + "description": "SHA for the commit's tree" }, "message": { - "type": "string" + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] }, "timestamp": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", - "format": "date-time" + "examples": [ + "2014-08-09T08:02:04+12:00" + ] }, "author": { "type": [ "object", "null" ], + "description": "Information about the Git author", "properties": { "name": { - "type": "string" + "description": "Name of the commit's author", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's author", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -24756,12 +24779,22 @@ "object", "null" ], + "description": "Information about the Git committer", "properties": { "name": { - "type": "string" + "description": "Name of the commit's committer", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's committer", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -26897,29 +26930,52 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "description": "SHA for the commit", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] }, "tree_id": { - "type": "string" + "type": "string", + "description": "SHA for the commit's tree" }, "message": { - "type": "string" + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] }, "timestamp": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", - "format": "date-time" + "examples": [ + "2014-08-09T08:02:04+12:00" + ] }, "author": { "type": [ "object", "null" ], + "description": "Information about the Git author", "properties": { "name": { - "type": "string" + "description": "Name of the commit's author", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's author", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -26932,12 +26988,22 @@ "object", "null" ], + "description": "Information about the Git committer", "properties": { "name": { - "type": "string" + "description": "Name of the commit's committer", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's committer", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -31254,29 +31320,52 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "description": "SHA for the commit", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] }, "tree_id": { - "type": "string" + "type": "string", + "description": "SHA for the commit's tree" }, "message": { - "type": "string" + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] }, "timestamp": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", - "format": "date-time" + "examples": [ + "2014-08-09T08:02:04+12:00" + ] }, "author": { "type": [ "object", "null" ], + "description": "Information about the Git author", "properties": { "name": { - "type": "string" + "description": "Name of the commit's author", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's author", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -31289,12 +31378,22 @@ "object", "null" ], + "description": "Information about the Git committer", "properties": { "name": { - "type": "string" + "description": "Name of the commit's committer", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's committer", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -132572,29 +132671,52 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "description": "SHA for the commit", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] }, "tree_id": { - "type": "string" + "type": "string", + "description": "SHA for the commit's tree" }, "message": { - "type": "string" + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] }, "timestamp": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", - "format": "date-time" + "examples": [ + "2014-08-09T08:02:04+12:00" + ] }, "author": { "type": [ "object", "null" ], + "description": "Information about the Git author", "properties": { "name": { - "type": "string" + "description": "Name of the commit's author", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's author", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -132607,12 +132729,22 @@ "object", "null" ], + "description": "Information about the Git committer", "properties": { "name": { - "type": "string" + "description": "Name of the commit's committer", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's committer", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -134304,29 +134436,52 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "description": "SHA for the commit", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] }, "tree_id": { - "type": "string" + "type": "string", + "description": "SHA for the commit's tree" }, "message": { - "type": "string" + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] }, "timestamp": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", - "format": "date-time" + "examples": [ + "2014-08-09T08:02:04+12:00" + ] }, "author": { "type": [ "object", "null" ], + "description": "Information about the Git author", "properties": { "name": { - "type": "string" + "description": "Name of the commit's author", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's author", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -134339,12 +134494,22 @@ "object", "null" ], + "description": "Information about the Git committer", "properties": { "name": { - "type": "string" + "description": "Name of the commit's committer", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's committer", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -137221,29 +137386,52 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "description": "SHA for the commit", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] }, "tree_id": { - "type": "string" + "type": "string", + "description": "SHA for the commit's tree" }, "message": { - "type": "string" + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] }, "timestamp": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", - "format": "date-time" + "examples": [ + "2014-08-09T08:02:04+12:00" + ] }, "author": { "type": [ "object", "null" ], + "description": "Information about the Git author", "properties": { "name": { - "type": "string" + "description": "Name of the commit's author", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's author", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -137256,12 +137444,22 @@ "object", "null" ], + "description": "Information about the Git committer", "properties": { "name": { - "type": "string" + "description": "Name of the commit's committer", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's committer", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -139006,29 +139204,52 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "description": "SHA for the commit", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] }, "tree_id": { - "type": "string" + "type": "string", + "description": "SHA for the commit's tree" }, "message": { - "type": "string" + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] }, "timestamp": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", - "format": "date-time" + "examples": [ + "2014-08-09T08:02:04+12:00" + ] }, "author": { "type": [ "object", "null" ], + "description": "Information about the Git author", "properties": { "name": { - "type": "string" + "description": "Name of the commit's author", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's author", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -139041,12 +139262,22 @@ "object", "null" ], + "description": "Information about the Git committer", "properties": { "name": { - "type": "string" + "description": "Name of the commit's committer", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's committer", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -163330,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", @@ -164961,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", @@ -167053,7 +167284,7 @@ } ], "previews": [], - "descriptionHTML": "

Deployments offer a few configurable parameters with certain defaults.

\n

The ref parameter can be any named branch, tag, or SHA. At GitHub Enterprise Server we often deploy branches and verify them\nbefore we merge a pull request.

\n

The environment parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as production, staging, and qa. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is production.

\n

The auto_merge parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref is behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.

\n

By default, commit statuses for every submitted context must be in a success\nstate. The required_contexts parameter allows you to specify a subset of contexts that must be success, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.

\n

The payload parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.

\n

The task parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe deploy:migrations to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.

\n

Users with repo or repo_deployment scopes can create a deployment for a given ref.

\n

Merged branch response #

\n

You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:

\n\n

If there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.

\n

Merge conflict response #

\n

This error happens when the auto_merge option is enabled and when the default branch (in this case master), can't\nbe merged into the branch that's being deployed (in this case topic-branch), due to merge conflicts.

\n

Failed commit status checks #

\n

This error happens when the required_contexts parameter indicates that one or more contexts need to have a success\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of success.

", + "descriptionHTML": "

Deployments offer a few configurable parameters with certain defaults.

\n

The ref parameter can be any named branch, tag, or SHA. At GitHub Enterprise Server we often deploy branches and verify them\nbefore we merge a pull request.

\n

The environment parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as production, staging, and qa. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is production.

\n

The auto_merge parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref is behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.

\n

By default, commit statuses for every submitted context must be in a success\nstate. The required_contexts parameter allows you to specify a subset of contexts that must be success, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.

\n

The payload parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.

\n

The task parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe deploy:migrations to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.

\n

Users with repo or repo_deployment scopes can create a deployment for a given ref.

\n

Merged branch response

\n

You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:

\n\n

If there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.

\n

Merge conflict response

\n

This error happens when the auto_merge option is enabled and when the default branch (in this case master), can't\nbe merged into the branch that's being deployed (in this case topic-branch), due to merge conflicts.

\n

Failed commit status checks

\n

This error happens when the required_contexts parameter indicates that one or more contexts need to have a success\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of success.

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

Gets information about a GitHub Enterprise Server Pages site.

\n

A token with the repo scope is required. GitHub Apps must have the pages:read permission.

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

Lists builts of a GitHub Enterprise Server Pages site.

\n

A token with the repo scope is required. GitHub Apps must have the pages:read permission.

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

Gets information about the single most recent build of a GitHub Enterprise Server Pages site.

\n

A token with the repo scope is required. GitHub Apps must have the pages:read permission.

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

Gets information about a GitHub Enterprise Server Pages build.

\n

A token with the repo scope is required. GitHub Apps must have the pages:read permission.

", "statusCodes": [ { "httpStatusCode": "200", @@ -393558,7 +393789,7 @@ } ], "previews": [], - "descriptionHTML": "

Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.

\n

Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.

\n

Notes:

\n\n

If the content is a directory #

\n

The response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".

\n

If the content is a symlink #

\n

If the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.

\n

If the content is a submodule #

\n

The submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.

\n

If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.

", + "descriptionHTML": "

Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.

\n

Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.

\n

Notes:

\n\n

If the content is a directory

\n

The response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".

\n

If the content is a symlink

\n

If the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.

\n

If the content is a submodule

\n

The submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.

\n

If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.

", "statusCodes": [ { "httpStatusCode": "200", @@ -403112,7 +403343,7 @@ } ], "previews": [], - "descriptionHTML": "

Searches for query terms inside of a file. This method returns up to 100 results per page.

\n

When searching for code, you can get text match metadata for the file content and file path fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

\n

For example, if you want to find the definition of the addClass function inside jQuery repository, your query would look something like this:

\n

q=addClass+in:file+language:js+repo:jquery/jquery

\n

This query searches for the keyword addClass within a file's contents. The query limits the search to files where the language is JavaScript in the jquery/jquery repository.

\n

Considerations for code search #

\n

Due to the complexity of searching code, there are a few restrictions on how searches are performed:

\n", + "descriptionHTML": "

Searches for query terms inside of a file. This method returns up to 100 results per page.

\n

When searching for code, you can get text match metadata for the file content and file path fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

\n

For example, if you want to find the definition of the addClass function inside jQuery repository, your query would look something like this:

\n

q=addClass+in:file+language:js+repo:jquery/jquery

\n

This query searches for the keyword addClass within a file's contents. The query limits the search to files where the language is JavaScript in the jquery/jquery repository.

\n

Considerations for code search

\n

Due to the complexity of searching code, there are a few restrictions on how searches are performed:

\n", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/data/ghes-3.5/schema.json b/src/rest/data/ghes-3.5/schema.json index 3d7e07a013..72aea6207a 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", @@ -13400,7 +13400,7 @@ "description": "

Created

" } ], - "descriptionHTML": "

Returns a token that you can pass to the config script. The token expires after one hour.

\n

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

\n

Example using registration token #

\n

Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.

\n
./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n
" + "descriptionHTML": "

Returns a token that you can pass to the config script. The token expires after one hour.

\n

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

\n

Example using registration token

\n

Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.

\n
./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -14885,7 +14885,7 @@ "description": "

Created

" } ], - "descriptionHTML": "

Returns a token that you can pass to the config script to remove a self-hosted runner from an enterprise. The token expires after one hour.

\n

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

\n

Example using remove token #

\n

To remove your self-hosted runner from an enterprise, replace TOKEN with the remove token provided by this\nendpoint.

\n
./config.sh remove --token TOKEN\n
" + "descriptionHTML": "

Returns a token that you can pass to the config script to remove a self-hosted runner from an enterprise. The token expires after one hour.

\n

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

\n

Example using remove token

\n

To remove your self-hosted runner from an enterprise, replace TOKEN with the remove token provided by this\nendpoint.

\n
./config.sh remove --token TOKEN\n
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -17615,7 +17615,7 @@ "description": "

Created

" } ], - "descriptionHTML": "

Returns a token that you can pass to the config script. The token expires after one hour.

\n

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

\n

Example using registration token #

\n

Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.

\n
./config.sh --url https://github.com/octo-org --token TOKEN\n
" + "descriptionHTML": "

Returns a token that you can pass to the config script. The token expires after one hour.

\n

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

\n

Example using registration token

\n

Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.

\n
./config.sh --url https://github.com/octo-org --token TOKEN\n
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -19100,7 +19100,7 @@ "description": "

Created

" } ], - "descriptionHTML": "

Returns a token that you can pass to the config script to remove a self-hosted runner from an organization. The token expires after one hour.

\n

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

\n

Example using remove token #

\n

To remove your self-hosted runner from an organization, replace TOKEN with the remove token provided by this\nendpoint.

\n
./config.sh remove --token TOKEN\n
" + "descriptionHTML": "

Returns a token that you can pass to the config script to remove a self-hosted runner from an organization. The token expires after one hour.

\n

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

\n

Example using remove token

\n

To remove your self-hosted runner from an organization, replace TOKEN with the remove token provided by this\nendpoint.

\n
./config.sh remove --token TOKEN\n
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -21856,7 +21856,7 @@ "description": "

Created

" } ], - "descriptionHTML": "

Returns a token that you can pass to the config script. The token expires after one hour. You must authenticate\nusing an access token with the repo scope to use this endpoint.

\n

Example using registration token #

\n

Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.

\n
./config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN\n
" + "descriptionHTML": "

Returns a token that you can pass to the config script. The token expires after one hour. You must authenticate\nusing an access token with the repo scope to use this endpoint.

\n

Example using registration token

\n

Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.

\n
./config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN\n
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -23351,7 +23351,7 @@ "description": "

Created

" } ], - "descriptionHTML": "

Returns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour.\nYou must authenticate using an access token with the repo scope to use this endpoint.

\n

Example using remove token #

\n

To remove your self-hosted runner from a repository, replace TOKEN with the remove token provided by this endpoint.

\n
./config.sh remove --token TOKEN\n
" + "descriptionHTML": "

Returns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour.\nYou must authenticate using an access token with the repo scope to use this endpoint.

\n

Example using remove token

\n

To remove your self-hosted runner from a repository, replace TOKEN with the remove token provided by this endpoint.

\n
./config.sh remove --token TOKEN\n
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -26903,29 +26903,52 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "description": "SHA for the commit", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] }, "tree_id": { - "type": "string" + "type": "string", + "description": "SHA for the commit's tree" }, "message": { - "type": "string" + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] }, "timestamp": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", - "format": "date-time" + "examples": [ + "2014-08-09T08:02:04+12:00" + ] }, "author": { "type": [ "object", "null" ], + "description": "Information about the Git author", "properties": { "name": { - "type": "string" + "description": "Name of the commit's author", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's author", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -26938,12 +26961,22 @@ "object", "null" ], + "description": "Information about the Git committer", "properties": { "name": { - "type": "string" + "description": "Name of the commit's committer", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's committer", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -29478,29 +29511,52 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "description": "SHA for the commit", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] }, "tree_id": { - "type": "string" + "type": "string", + "description": "SHA for the commit's tree" }, "message": { - "type": "string" + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] }, "timestamp": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", - "format": "date-time" + "examples": [ + "2014-08-09T08:02:04+12:00" + ] }, "author": { "type": [ "object", "null" ], + "description": "Information about the Git author", "properties": { "name": { - "type": "string" + "description": "Name of the commit's author", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's author", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -29513,12 +29569,22 @@ "object", "null" ], + "description": "Information about the Git committer", "properties": { "name": { - "type": "string" + "description": "Name of the commit's committer", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's committer", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -32481,29 +32547,52 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "description": "SHA for the commit", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] }, "tree_id": { - "type": "string" + "type": "string", + "description": "SHA for the commit's tree" }, "message": { - "type": "string" + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] }, "timestamp": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", - "format": "date-time" + "examples": [ + "2014-08-09T08:02:04+12:00" + ] }, "author": { "type": [ "object", "null" ], + "description": "Information about the Git author", "properties": { "name": { - "type": "string" + "description": "Name of the commit's author", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's author", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -32516,12 +32605,22 @@ "object", "null" ], + "description": "Information about the Git committer", "properties": { "name": { - "type": "string" + "description": "Name of the commit's committer", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's committer", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -36974,29 +37073,52 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "description": "SHA for the commit", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] }, "tree_id": { - "type": "string" + "type": "string", + "description": "SHA for the commit's tree" }, "message": { - "type": "string" + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] }, "timestamp": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", - "format": "date-time" + "examples": [ + "2014-08-09T08:02:04+12:00" + ] }, "author": { "type": [ "object", "null" ], + "description": "Information about the Git author", "properties": { "name": { - "type": "string" + "description": "Name of the commit's author", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's author", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -37009,12 +37131,22 @@ "object", "null" ], + "description": "Information about the Git committer", "properties": { "name": { - "type": "string" + "description": "Name of the commit's committer", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's committer", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -138340,29 +138472,52 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "description": "SHA for the commit", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] }, "tree_id": { - "type": "string" + "type": "string", + "description": "SHA for the commit's tree" }, "message": { - "type": "string" + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] }, "timestamp": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", - "format": "date-time" + "examples": [ + "2014-08-09T08:02:04+12:00" + ] }, "author": { "type": [ "object", "null" ], + "description": "Information about the Git author", "properties": { "name": { - "type": "string" + "description": "Name of the commit's author", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's author", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -138375,12 +138530,22 @@ "object", "null" ], + "description": "Information about the Git committer", "properties": { "name": { - "type": "string" + "description": "Name of the commit's committer", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's committer", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -140078,29 +140243,52 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "description": "SHA for the commit", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] }, "tree_id": { - "type": "string" + "type": "string", + "description": "SHA for the commit's tree" }, "message": { - "type": "string" + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] }, "timestamp": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", - "format": "date-time" + "examples": [ + "2014-08-09T08:02:04+12:00" + ] }, "author": { "type": [ "object", "null" ], + "description": "Information about the Git author", "properties": { "name": { - "type": "string" + "description": "Name of the commit's author", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's author", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -140113,12 +140301,22 @@ "object", "null" ], + "description": "Information about the Git committer", "properties": { "name": { - "type": "string" + "description": "Name of the commit's committer", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's committer", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -143007,29 +143205,52 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "description": "SHA for the commit", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] }, "tree_id": { - "type": "string" + "type": "string", + "description": "SHA for the commit's tree" }, "message": { - "type": "string" + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] }, "timestamp": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", - "format": "date-time" + "examples": [ + "2014-08-09T08:02:04+12:00" + ] }, "author": { "type": [ "object", "null" ], + "description": "Information about the Git author", "properties": { "name": { - "type": "string" + "description": "Name of the commit's author", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's author", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -143042,12 +143263,22 @@ "object", "null" ], + "description": "Information about the Git committer", "properties": { "name": { - "type": "string" + "description": "Name of the commit's committer", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's committer", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -144798,29 +145029,52 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "description": "SHA for the commit", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] }, "tree_id": { - "type": "string" + "type": "string", + "description": "SHA for the commit's tree" }, "message": { - "type": "string" + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] }, "timestamp": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", - "format": "date-time" + "examples": [ + "2014-08-09T08:02:04+12:00" + ] }, "author": { "type": [ "object", "null" ], + "description": "Information about the Git author", "properties": { "name": { - "type": "string" + "description": "Name of the commit's author", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's author", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -144833,12 +145087,22 @@ "object", "null" ], + "description": "Information about the Git committer", "properties": { "name": { - "type": "string" + "description": "Name of the commit's committer", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's committer", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -170572,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", @@ -172209,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", @@ -174301,7 +174565,7 @@ } ], "previews": [], - "descriptionHTML": "

Deployments offer a few configurable parameters with certain defaults.

\n

The ref parameter can be any named branch, tag, or SHA. At GitHub Enterprise Server we often deploy branches and verify them\nbefore we merge a pull request.

\n

The environment parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as production, staging, and qa. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is production.

\n

The auto_merge parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref is behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.

\n

By default, commit statuses for every submitted context must be in a success\nstate. The required_contexts parameter allows you to specify a subset of contexts that must be success, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.

\n

The payload parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.

\n

The task parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe deploy:migrations to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.

\n

Users with repo or repo_deployment scopes can create a deployment for a given ref.

\n

Merged branch response #

\n

You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:

\n\n

If there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.

\n

Merge conflict response #

\n

This error happens when the auto_merge option is enabled and when the default branch (in this case master), can't\nbe merged into the branch that's being deployed (in this case topic-branch), due to merge conflicts.

\n

Failed commit status checks #

\n

This error happens when the required_contexts parameter indicates that one or more contexts need to have a success\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of success.

", + "descriptionHTML": "

Deployments offer a few configurable parameters with certain defaults.

\n

The ref parameter can be any named branch, tag, or SHA. At GitHub Enterprise Server we often deploy branches and verify them\nbefore we merge a pull request.

\n

The environment parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as production, staging, and qa. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is production.

\n

The auto_merge parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref is behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.

\n

By default, commit statuses for every submitted context must be in a success\nstate. The required_contexts parameter allows you to specify a subset of contexts that must be success, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.

\n

The payload parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.

\n

The task parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe deploy:migrations to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.

\n

Users with repo or repo_deployment scopes can create a deployment for a given ref.

\n

Merged branch response

\n

You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:

\n\n

If there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.

\n

Merge conflict response

\n

This error happens when the auto_merge option is enabled and when the default branch (in this case master), can't\nbe merged into the branch that's being deployed (in this case topic-branch), due to merge conflicts.

\n

Failed commit status checks

\n

This error happens when the required_contexts parameter indicates that one or more contexts need to have a success\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of success.

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

Gets information about a GitHub Enterprise Server Pages site.

\n

A token with the repo scope is required. GitHub Apps must have the pages:read permission.

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

Lists builts of a GitHub Enterprise Server Pages site.

\n

A token with the repo scope is required. GitHub Apps must have the pages:read permission.

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

Gets information about the single most recent build of a GitHub Enterprise Server Pages site.

\n

A token with the repo scope is required. GitHub Apps must have the pages:read permission.

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

Gets information about a GitHub Enterprise Server Pages build.

\n

A token with the repo scope is required. GitHub Apps must have the pages:read permission.

", "statusCodes": [ { "httpStatusCode": "200", @@ -400949,7 +401213,7 @@ } ], "previews": [], - "descriptionHTML": "

Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.

\n

Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.

\n

Notes:

\n\n

If the content is a directory #

\n

The response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".

\n

If the content is a symlink #

\n

If the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.

\n

If the content is a submodule #

\n

The submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.

\n

If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.

", + "descriptionHTML": "

Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.

\n

Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.

\n

Notes:

\n\n

If the content is a directory

\n

The response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".

\n

If the content is a symlink

\n

If the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.

\n

If the content is a submodule

\n

The submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.

\n

If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.

", "statusCodes": [ { "httpStatusCode": "200", @@ -410822,7 +411086,7 @@ } ], "previews": [], - "descriptionHTML": "

Searches for query terms inside of a file. This method returns up to 100 results per page.

\n

When searching for code, you can get text match metadata for the file content and file path fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

\n

For example, if you want to find the definition of the addClass function inside jQuery repository, your query would look something like this:

\n

q=addClass+in:file+language:js+repo:jquery/jquery

\n

This query searches for the keyword addClass within a file's contents. The query limits the search to files where the language is JavaScript in the jquery/jquery repository.

\n

Considerations for code search #

\n

Due to the complexity of searching code, there are a few restrictions on how searches are performed:

\n", + "descriptionHTML": "

Searches for query terms inside of a file. This method returns up to 100 results per page.

\n

When searching for code, you can get text match metadata for the file content and file path fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

\n

For example, if you want to find the definition of the addClass function inside jQuery repository, your query would look something like this:

\n

q=addClass+in:file+language:js+repo:jquery/jquery

\n

This query searches for the keyword addClass within a file's contents. The query limits the search to files where the language is JavaScript in the jquery/jquery repository.

\n

Considerations for code search

\n

Due to the complexity of searching code, there are a few restrictions on how searches are performed:

\n", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/data/ghes-3.6/schema.json b/src/rest/data/ghes-3.6/schema.json index 7cf37414e2..8404aa9e48 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", @@ -13929,7 +13929,7 @@ "description": "

Created

" } ], - "descriptionHTML": "

Returns a token that you can pass to the config script. The token expires after one hour.

\n

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

\n

Example using registration token #

\n

Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.

\n
./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n
" + "descriptionHTML": "

Returns a token that you can pass to the config script. The token expires after one hour.

\n

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

\n

Example using registration token

\n

Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.

\n
./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -15496,7 +15496,7 @@ "description": "

Created

" } ], - "descriptionHTML": "

Returns a token that you can pass to the config script to remove a self-hosted runner from an enterprise. The token expires after one hour.

\n

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

\n

Example using remove token #

\n

To remove your self-hosted runner from an enterprise, replace TOKEN with the remove token provided by this\nendpoint.

\n
./config.sh remove --token TOKEN\n
" + "descriptionHTML": "

Returns a token that you can pass to the config script to remove a self-hosted runner from an enterprise. The token expires after one hour.

\n

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

\n

Example using remove token

\n

To remove your self-hosted runner from an enterprise, replace TOKEN with the remove token provided by this\nendpoint.

\n
./config.sh remove --token TOKEN\n
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -18308,7 +18308,7 @@ "description": "

Created

" } ], - "descriptionHTML": "

Returns a token that you can pass to the config script. The token expires after one hour.

\n

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

\n

Example using registration token #

\n

Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.

\n
./config.sh --url https://github.com/octo-org --token TOKEN\n
" + "descriptionHTML": "

Returns a token that you can pass to the config script. The token expires after one hour.

\n

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

\n

Example using registration token

\n

Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.

\n
./config.sh --url https://github.com/octo-org --token TOKEN\n
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -19875,7 +19875,7 @@ "description": "

Created

" } ], - "descriptionHTML": "

Returns a token that you can pass to the config script to remove a self-hosted runner from an organization. The token expires after one hour.

\n

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

\n

Example using remove token #

\n

To remove your self-hosted runner from an organization, replace TOKEN with the remove token provided by this\nendpoint.

\n
./config.sh remove --token TOKEN\n
" + "descriptionHTML": "

Returns a token that you can pass to the config script to remove a self-hosted runner from an organization. The token expires after one hour.

\n

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

\n

Example using remove token

\n

To remove your self-hosted runner from an organization, replace TOKEN with the remove token provided by this\nendpoint.

\n
./config.sh remove --token TOKEN\n
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -22713,7 +22713,7 @@ "description": "

Created

" } ], - "descriptionHTML": "

Returns a token that you can pass to the config script. The token expires after one hour. You must authenticate\nusing an access token with the repo scope to use this endpoint.

\n

Example using registration token #

\n

Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.

\n
./config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN\n
" + "descriptionHTML": "

Returns a token that you can pass to the config script. The token expires after one hour. You must authenticate\nusing an access token with the repo scope to use this endpoint.

\n

Example using registration token

\n

Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.

\n
./config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN\n
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -24290,7 +24290,7 @@ "description": "

Created

" } ], - "descriptionHTML": "

Returns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour.\nYou must authenticate using an access token with the repo scope to use this endpoint.

\n

Example using remove token #

\n

To remove your self-hosted runner from a repository, replace TOKEN with the remove token provided by this endpoint.

\n
./config.sh remove --token TOKEN\n
" + "descriptionHTML": "

Returns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour.\nYou must authenticate using an access token with the repo scope to use this endpoint.

\n

Example using remove token

\n

To remove your self-hosted runner from a repository, replace TOKEN with the remove token provided by this endpoint.

\n
./config.sh remove --token TOKEN\n
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -27883,29 +27883,52 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "description": "SHA for the commit", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] }, "tree_id": { - "type": "string" + "type": "string", + "description": "SHA for the commit's tree" }, "message": { - "type": "string" + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] }, "timestamp": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", - "format": "date-time" + "examples": [ + "2014-08-09T08:02:04+12:00" + ] }, "author": { "type": [ "object", "null" ], + "description": "Information about the Git author", "properties": { "name": { - "type": "string" + "description": "Name of the commit's author", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's author", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -27918,12 +27941,22 @@ "object", "null" ], + "description": "Information about the Git committer", "properties": { "name": { - "type": "string" + "description": "Name of the commit's committer", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's committer", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -30519,29 +30552,52 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "description": "SHA for the commit", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] }, "tree_id": { - "type": "string" + "type": "string", + "description": "SHA for the commit's tree" }, "message": { - "type": "string" + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] }, "timestamp": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", - "format": "date-time" + "examples": [ + "2014-08-09T08:02:04+12:00" + ] }, "author": { "type": [ "object", "null" ], + "description": "Information about the Git author", "properties": { "name": { - "type": "string" + "description": "Name of the commit's author", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's author", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -30554,12 +30610,22 @@ "object", "null" ], + "description": "Information about the Git committer", "properties": { "name": { - "type": "string" + "description": "Name of the commit's committer", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's committer", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -33583,29 +33649,52 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "description": "SHA for the commit", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] }, "tree_id": { - "type": "string" + "type": "string", + "description": "SHA for the commit's tree" }, "message": { - "type": "string" + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] }, "timestamp": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", - "format": "date-time" + "examples": [ + "2014-08-09T08:02:04+12:00" + ] }, "author": { "type": [ "object", "null" ], + "description": "Information about the Git author", "properties": { "name": { - "type": "string" + "description": "Name of the commit's author", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's author", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -33618,12 +33707,22 @@ "object", "null" ], + "description": "Information about the Git committer", "properties": { "name": { - "type": "string" + "description": "Name of the commit's committer", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's committer", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -38137,29 +38236,52 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "description": "SHA for the commit", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] }, "tree_id": { - "type": "string" + "type": "string", + "description": "SHA for the commit's tree" }, "message": { - "type": "string" + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] }, "timestamp": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", - "format": "date-time" + "examples": [ + "2014-08-09T08:02:04+12:00" + ] }, "author": { "type": [ "object", "null" ], + "description": "Information about the Git author", "properties": { "name": { - "type": "string" + "description": "Name of the commit's author", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's author", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -38172,12 +38294,22 @@ "object", "null" ], + "description": "Information about the Git committer", "properties": { "name": { - "type": "string" + "description": "Name of the commit's committer", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's committer", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -140863,29 +140995,52 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "description": "SHA for the commit", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] }, "tree_id": { - "type": "string" + "type": "string", + "description": "SHA for the commit's tree" }, "message": { - "type": "string" + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] }, "timestamp": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", - "format": "date-time" + "examples": [ + "2014-08-09T08:02:04+12:00" + ] }, "author": { "type": [ "object", "null" ], + "description": "Information about the Git author", "properties": { "name": { - "type": "string" + "description": "Name of the commit's author", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's author", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -140898,12 +141053,22 @@ "object", "null" ], + "description": "Information about the Git committer", "properties": { "name": { - "type": "string" + "description": "Name of the commit's committer", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's committer", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -142607,29 +142772,52 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "description": "SHA for the commit", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] }, "tree_id": { - "type": "string" + "type": "string", + "description": "SHA for the commit's tree" }, "message": { - "type": "string" + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] }, "timestamp": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", - "format": "date-time" + "examples": [ + "2014-08-09T08:02:04+12:00" + ] }, "author": { "type": [ "object", "null" ], + "description": "Information about the Git author", "properties": { "name": { - "type": "string" + "description": "Name of the commit's author", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's author", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -142642,12 +142830,22 @@ "object", "null" ], + "description": "Information about the Git committer", "properties": { "name": { - "type": "string" + "description": "Name of the commit's committer", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's committer", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -145548,29 +145746,52 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "description": "SHA for the commit", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] }, "tree_id": { - "type": "string" + "type": "string", + "description": "SHA for the commit's tree" }, "message": { - "type": "string" + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] }, "timestamp": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", - "format": "date-time" + "examples": [ + "2014-08-09T08:02:04+12:00" + ] }, "author": { "type": [ "object", "null" ], + "description": "Information about the Git author", "properties": { "name": { - "type": "string" + "description": "Name of the commit's author", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's author", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -145583,12 +145804,22 @@ "object", "null" ], + "description": "Information about the Git committer", "properties": { "name": { - "type": "string" + "description": "Name of the commit's committer", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's committer", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -147345,29 +147576,52 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "description": "SHA for the commit", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] }, "tree_id": { - "type": "string" + "type": "string", + "description": "SHA for the commit's tree" }, "message": { - "type": "string" + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] }, "timestamp": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", - "format": "date-time" + "examples": [ + "2014-08-09T08:02:04+12:00" + ] }, "author": { "type": [ "object", "null" ], + "description": "Information about the Git author", "properties": { "name": { - "type": "string" + "description": "Name of the commit's author", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's author", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -147380,12 +147634,22 @@ "object", "null" ], + "description": "Information about the Git committer", "properties": { "name": { - "type": "string" + "description": "Name of the commit's committer", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's committer", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -173359,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", @@ -175002,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", @@ -177339,7 +177603,7 @@ } ], "previews": [], - "descriptionHTML": "

Deployments offer a few configurable parameters with certain defaults.

\n

The ref parameter can be any named branch, tag, or SHA. At GitHub Enterprise Server we often deploy branches and verify them\nbefore we merge a pull request.

\n

The environment parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as production, staging, and qa. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is production.

\n

The auto_merge parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref is behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.

\n

By default, commit statuses for every submitted context must be in a success\nstate. The required_contexts parameter allows you to specify a subset of contexts that must be success, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.

\n

The payload parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.

\n

The task parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe deploy:migrations to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.

\n

Users with repo or repo_deployment scopes can create a deployment for a given ref.

\n

Merged branch response #

\n

You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:

\n\n

If there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.

\n

Merge conflict response #

\n

This error happens when the auto_merge option is enabled and when the default branch (in this case master), can't\nbe merged into the branch that's being deployed (in this case topic-branch), due to merge conflicts.

\n

Failed commit status checks #

\n

This error happens when the required_contexts parameter indicates that one or more contexts need to have a success\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of success.

", + "descriptionHTML": "

Deployments offer a few configurable parameters with certain defaults.

\n

The ref parameter can be any named branch, tag, or SHA. At GitHub Enterprise Server we often deploy branches and verify them\nbefore we merge a pull request.

\n

The environment parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as production, staging, and qa. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is production.

\n

The auto_merge parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref is behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.

\n

By default, commit statuses for every submitted context must be in a success\nstate. The required_contexts parameter allows you to specify a subset of contexts that must be success, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.

\n

The payload parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.

\n

The task parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe deploy:migrations to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.

\n

Users with repo or repo_deployment scopes can create a deployment for a given ref.

\n

Merged branch response

\n

You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:

\n\n

If there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.

\n

Merge conflict response

\n

This error happens when the auto_merge option is enabled and when the default branch (in this case master), can't\nbe merged into the branch that's being deployed (in this case topic-branch), due to merge conflicts.

\n

Failed commit status checks

\n

This error happens when the required_contexts parameter indicates that one or more contexts need to have a success\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of success.

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

Gets information about a GitHub Enterprise Server Pages site.

\n

A token with the repo scope is required. GitHub Apps must have the pages:read permission.

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

Lists builts of a GitHub Enterprise Server Pages site.

\n

A token with the repo scope is required. GitHub Apps must have the pages:read permission.

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

Gets information about the single most recent build of a GitHub Enterprise Server Pages site.

\n

A token with the repo scope is required. GitHub Apps must have the pages:read permission.

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

Gets information about a GitHub Enterprise Server Pages build.

\n

A token with the repo scope is required. GitHub Apps must have the pages:read permission.

", "statusCodes": [ { "httpStatusCode": "200", @@ -412190,7 +412454,7 @@ } ], "previews": [], - "descriptionHTML": "

Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.

\n

Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.

\n

Notes:

\n\n

Size limits #

\n

If the requested file's size is:

\n\n

If the content is a directory #

\n

The response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".

\n

If the content is a symlink #

\n

If the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.

\n

If the content is a submodule #

\n

The submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.

\n

If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.

", + "descriptionHTML": "

Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.

\n

Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.

\n

Notes:

\n\n

Size limits

\n

If the requested file's size is:

\n\n

If the content is a directory

\n

The response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".

\n

If the content is a symlink

\n

If the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.

\n

If the content is a submodule

\n

The submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.

\n

If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.

", "statusCodes": [ { "httpStatusCode": "200", @@ -422381,7 +422645,7 @@ } ], "previews": [], - "descriptionHTML": "

Searches for query terms inside of a file. This method returns up to 100 results per page.

\n

When searching for code, you can get text match metadata for the file content and file path fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

\n

For example, if you want to find the definition of the addClass function inside jQuery repository, your query would look something like this:

\n

q=addClass+in:file+language:js+repo:jquery/jquery

\n

This query searches for the keyword addClass within a file's contents. The query limits the search to files where the language is JavaScript in the jquery/jquery repository.

\n

Considerations for code search #

\n

Due to the complexity of searching code, there are a few restrictions on how searches are performed:

\n", + "descriptionHTML": "

Searches for query terms inside of a file. This method returns up to 100 results per page.

\n

When searching for code, you can get text match metadata for the file content and file path fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

\n

For example, if you want to find the definition of the addClass function inside jQuery repository, your query would look something like this:

\n

q=addClass+in:file+language:js+repo:jquery/jquery

\n

This query searches for the keyword addClass within a file's contents. The query limits the search to files where the language is JavaScript in the jquery/jquery repository.

\n

Considerations for code search

\n

Due to the complexity of searching code, there are a few restrictions on how searches are performed:

\n", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/data/ghes-3.7/schema.json b/src/rest/data/ghes-3.7/schema.json index 8324dd5884..660dc4aba9 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", @@ -14709,7 +14709,7 @@ "description": "

Created

" } ], - "descriptionHTML": "

Returns a token that you can pass to the config script. The token expires after one hour.

\n

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

\n

Example using registration token #

\n

Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.

\n
./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n
" + "descriptionHTML": "

Returns a token that you can pass to the config script. The token expires after one hour.

\n

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

\n

Example using registration token

\n

Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.

\n
./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -16284,7 +16284,7 @@ "description": "

Created

" } ], - "descriptionHTML": "

Returns a token that you can pass to the config script to remove a self-hosted runner from an enterprise. The token expires after one hour.

\n

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

\n

Example using remove token #

\n

To remove your self-hosted runner from an enterprise, replace TOKEN with the remove token provided by this\nendpoint.

\n
./config.sh remove --token TOKEN\n
" + "descriptionHTML": "

Returns a token that you can pass to the config script to remove a self-hosted runner from an enterprise. The token expires after one hour.

\n

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

\n

Example using remove token

\n

To remove your self-hosted runner from an enterprise, replace TOKEN with the remove token provided by this\nendpoint.

\n
./config.sh remove --token TOKEN\n
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -19104,7 +19104,7 @@ "description": "

Created

" } ], - "descriptionHTML": "

Returns a token that you can pass to the config script. The token expires after one hour.

\n

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

\n

Example using registration token #

\n

Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.

\n
./config.sh --url https://github.com/octo-org --token TOKEN\n
" + "descriptionHTML": "

Returns a token that you can pass to the config script. The token expires after one hour.

\n

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

\n

Example using registration token

\n

Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.

\n
./config.sh --url https://github.com/octo-org --token TOKEN\n
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -20679,7 +20679,7 @@ "description": "

Created

" } ], - "descriptionHTML": "

Returns a token that you can pass to the config script to remove a self-hosted runner from an organization. The token expires after one hour.

\n

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

\n

Example using remove token #

\n

To remove your self-hosted runner from an organization, replace TOKEN with the remove token provided by this\nendpoint.

\n
./config.sh remove --token TOKEN\n
" + "descriptionHTML": "

Returns a token that you can pass to the config script to remove a self-hosted runner from an organization. The token expires after one hour.

\n

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

\n

Example using remove token

\n

To remove your self-hosted runner from an organization, replace TOKEN with the remove token provided by this\nendpoint.

\n
./config.sh remove --token TOKEN\n
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -23525,7 +23525,7 @@ "description": "

Created

" } ], - "descriptionHTML": "

Returns a token that you can pass to the config script. The token expires after one hour. You must authenticate\nusing an access token with the repo scope to use this endpoint.

\n

Example using registration token #

\n

Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.

\n
./config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN\n
" + "descriptionHTML": "

Returns a token that you can pass to the config script. The token expires after one hour. You must authenticate\nusing an access token with the repo scope to use this endpoint.

\n

Example using registration token

\n

Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.

\n
./config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN\n
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -25110,7 +25110,7 @@ "description": "

Created

" } ], - "descriptionHTML": "

Returns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour.\nYou must authenticate using an access token with the repo scope to use this endpoint.

\n

Example using remove token #

\n

To remove your self-hosted runner from a repository, replace TOKEN with the remove token provided by this endpoint.

\n
./config.sh remove --token TOKEN\n
" + "descriptionHTML": "

Returns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour.\nYou must authenticate using an access token with the repo scope to use this endpoint.

\n

Example using remove token

\n

To remove your self-hosted runner from a repository, replace TOKEN with the remove token provided by this endpoint.

\n
./config.sh remove --token TOKEN\n
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -28712,29 +28712,52 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "description": "SHA for the commit", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] }, "tree_id": { - "type": "string" + "type": "string", + "description": "SHA for the commit's tree" }, "message": { - "type": "string" + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] }, "timestamp": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", - "format": "date-time" + "examples": [ + "2014-08-09T08:02:04+12:00" + ] }, "author": { "type": [ "object", "null" ], + "description": "Information about the Git author", "properties": { "name": { - "type": "string" + "description": "Name of the commit's author", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's author", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -28747,12 +28770,22 @@ "object", "null" ], + "description": "Information about the Git committer", "properties": { "name": { - "type": "string" + "description": "Name of the commit's committer", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's committer", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -31354,29 +31387,52 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "description": "SHA for the commit", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] }, "tree_id": { - "type": "string" + "type": "string", + "description": "SHA for the commit's tree" }, "message": { - "type": "string" + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] }, "timestamp": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", - "format": "date-time" + "examples": [ + "2014-08-09T08:02:04+12:00" + ] }, "author": { "type": [ "object", "null" ], + "description": "Information about the Git author", "properties": { "name": { - "type": "string" + "description": "Name of the commit's author", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's author", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -31389,12 +31445,22 @@ "object", "null" ], + "description": "Information about the Git committer", "properties": { "name": { - "type": "string" + "description": "Name of the commit's committer", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's committer", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -34424,29 +34490,52 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "description": "SHA for the commit", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] }, "tree_id": { - "type": "string" + "type": "string", + "description": "SHA for the commit's tree" }, "message": { - "type": "string" + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] }, "timestamp": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", - "format": "date-time" + "examples": [ + "2014-08-09T08:02:04+12:00" + ] }, "author": { "type": [ "object", "null" ], + "description": "Information about the Git author", "properties": { "name": { - "type": "string" + "description": "Name of the commit's author", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's author", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -34459,12 +34548,22 @@ "object", "null" ], + "description": "Information about the Git committer", "properties": { "name": { - "type": "string" + "description": "Name of the commit's committer", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's committer", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -38993,29 +39092,52 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "description": "SHA for the commit", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] }, "tree_id": { - "type": "string" + "type": "string", + "description": "SHA for the commit's tree" }, "message": { - "type": "string" + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] }, "timestamp": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", - "format": "date-time" + "examples": [ + "2014-08-09T08:02:04+12:00" + ] }, "author": { "type": [ "object", "null" ], + "description": "Information about the Git author", "properties": { "name": { - "type": "string" + "description": "Name of the commit's author", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's author", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -39028,12 +39150,22 @@ "object", "null" ], + "description": "Information about the Git committer", "properties": { "name": { - "type": "string" + "description": "Name of the commit's committer", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's committer", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -141837,29 +141969,52 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "description": "SHA for the commit", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] }, "tree_id": { - "type": "string" + "type": "string", + "description": "SHA for the commit's tree" }, "message": { - "type": "string" + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] }, "timestamp": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", - "format": "date-time" + "examples": [ + "2014-08-09T08:02:04+12:00" + ] }, "author": { "type": [ "object", "null" ], + "description": "Information about the Git author", "properties": { "name": { - "type": "string" + "description": "Name of the commit's author", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's author", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -141872,12 +142027,22 @@ "object", "null" ], + "description": "Information about the Git committer", "properties": { "name": { - "type": "string" + "description": "Name of the commit's committer", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's committer", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -143584,29 +143749,52 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "description": "SHA for the commit", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] }, "tree_id": { - "type": "string" + "type": "string", + "description": "SHA for the commit's tree" }, "message": { - "type": "string" + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] }, "timestamp": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", - "format": "date-time" + "examples": [ + "2014-08-09T08:02:04+12:00" + ] }, "author": { "type": [ "object", "null" ], + "description": "Information about the Git author", "properties": { "name": { - "type": "string" + "description": "Name of the commit's author", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's author", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -143619,12 +143807,22 @@ "object", "null" ], + "description": "Information about the Git committer", "properties": { "name": { - "type": "string" + "description": "Name of the commit's committer", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's committer", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -146531,29 +146729,52 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "description": "SHA for the commit", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] }, "tree_id": { - "type": "string" + "type": "string", + "description": "SHA for the commit's tree" }, "message": { - "type": "string" + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] }, "timestamp": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", - "format": "date-time" + "examples": [ + "2014-08-09T08:02:04+12:00" + ] }, "author": { "type": [ "object", "null" ], + "description": "Information about the Git author", "properties": { "name": { - "type": "string" + "description": "Name of the commit's author", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's author", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -146566,12 +146787,22 @@ "object", "null" ], + "description": "Information about the Git committer", "properties": { "name": { - "type": "string" + "description": "Name of the commit's committer", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's committer", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -148331,29 +148562,52 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "description": "SHA for the commit", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] }, "tree_id": { - "type": "string" + "type": "string", + "description": "SHA for the commit's tree" }, "message": { - "type": "string" + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] }, "timestamp": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", - "format": "date-time" + "examples": [ + "2014-08-09T08:02:04+12:00" + ] }, "author": { "type": [ "object", "null" ], + "description": "Information about the Git author", "properties": { "name": { - "type": "string" + "description": "Name of the commit's author", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's author", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -148366,12 +148620,22 @@ "object", "null" ], + "description": "Information about the Git committer", "properties": { "name": { - "type": "string" + "description": "Name of the commit's committer", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's committer", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -175810,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", @@ -177456,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", @@ -180150,7 +180414,7 @@ } ], "previews": [], - "descriptionHTML": "

Deployments offer a few configurable parameters with certain defaults.

\n

The ref parameter can be any named branch, tag, or SHA. At GitHub Enterprise Server we often deploy branches and verify them\nbefore we merge a pull request.

\n

The environment parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as production, staging, and qa. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is production.

\n

The auto_merge parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref is behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.

\n

By default, commit statuses for every submitted context must be in a success\nstate. The required_contexts parameter allows you to specify a subset of contexts that must be success, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.

\n

The payload parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.

\n

The task parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe deploy:migrations to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.

\n

Users with repo or repo_deployment scopes can create a deployment for a given ref.

\n

Merged branch response #

\n

You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:

\n\n

If there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.

\n

Merge conflict response #

\n

This error happens when the auto_merge option is enabled and when the default branch (in this case master), can't\nbe merged into the branch that's being deployed (in this case topic-branch), due to merge conflicts.

\n

Failed commit status checks #

\n

This error happens when the required_contexts parameter indicates that one or more contexts need to have a success\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of success.

", + "descriptionHTML": "

Deployments offer a few configurable parameters with certain defaults.

\n

The ref parameter can be any named branch, tag, or SHA. At GitHub Enterprise Server we often deploy branches and verify them\nbefore we merge a pull request.

\n

The environment parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as production, staging, and qa. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is production.

\n

The auto_merge parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref is behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.

\n

By default, commit statuses for every submitted context must be in a success\nstate. The required_contexts parameter allows you to specify a subset of contexts that must be success, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.

\n

The payload parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.

\n

The task parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe deploy:migrations to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.

\n

Users with repo or repo_deployment scopes can create a deployment for a given ref.

\n

Merged branch response

\n

You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:

\n\n

If there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.

\n

Merge conflict response

\n

This error happens when the auto_merge option is enabled and when the default branch (in this case master), can't\nbe merged into the branch that's being deployed (in this case topic-branch), due to merge conflicts.

\n

Failed commit status checks

\n

This error happens when the required_contexts parameter indicates that one or more contexts need to have a success\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of success.

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

Gets information about a GitHub Enterprise Server Pages site.

\n

A token with the repo scope is required. GitHub Apps must have the pages:read permission.

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

Lists builts of a GitHub Enterprise Server Pages site.

\n

A token with the repo scope is required. GitHub Apps must have the pages:read permission.

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

Gets information about the single most recent build of a GitHub Enterprise Server Pages site.

\n

A token with the repo scope is required. GitHub Apps must have the pages:read permission.

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

Gets information about a GitHub Enterprise Server Pages build.

\n

A token with the repo scope is required. GitHub Apps must have the pages:read permission.

", "statusCodes": [ { "httpStatusCode": "200", @@ -415992,7 +416256,7 @@ } ], "previews": [], - "descriptionHTML": "

Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.

\n

Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.

\n

Notes:

\n\n

Size limits #

\n

If the requested file's size is:

\n\n

If the content is a directory #

\n

The response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".

\n

If the content is a symlink #

\n

If the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.

\n

If the content is a submodule #

\n

The submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.

\n

If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.

", + "descriptionHTML": "

Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.

\n

Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.

\n

Notes:

\n\n

Size limits

\n

If the requested file's size is:

\n\n

If the content is a directory

\n

The response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".

\n

If the content is a symlink

\n

If the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.

\n

If the content is a submodule

\n

The submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.

\n

If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.

", "statusCodes": [ { "httpStatusCode": "200", @@ -426231,7 +426495,7 @@ } ], "previews": [], - "descriptionHTML": "

Searches for query terms inside of a file. This method returns up to 100 results per page.

\n

When searching for code, you can get text match metadata for the file content and file path fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

\n

For example, if you want to find the definition of the addClass function inside jQuery repository, your query would look something like this:

\n

q=addClass+in:file+language:js+repo:jquery/jquery

\n

This query searches for the keyword addClass within a file's contents. The query limits the search to files where the language is JavaScript in the jquery/jquery repository.

\n

Considerations for code search #

\n

Due to the complexity of searching code, there are a few restrictions on how searches are performed:

\n", + "descriptionHTML": "

Searches for query terms inside of a file. This method returns up to 100 results per page.

\n

When searching for code, you can get text match metadata for the file content and file path fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

\n

For example, if you want to find the definition of the addClass function inside jQuery repository, your query would look something like this:

\n

q=addClass+in:file+language:js+repo:jquery/jquery

\n

This query searches for the keyword addClass within a file's contents. The query limits the search to files where the language is JavaScript in the jquery/jquery repository.

\n

Considerations for code search

\n

Due to the complexity of searching code, there are a few restrictions on how searches are performed:

\n", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/data/ghes-3.8/schema.json b/src/rest/data/ghes-3.8/schema.json index 933ebc219e..d93a19af99 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", @@ -22900,7 +22900,7 @@ "description": "

Created

" } ], - "descriptionHTML": "

Returns a token that you can pass to the config script. The token expires after one hour.

\n

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

\n

Example using registration token #

\n

Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.

\n
./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n
" + "descriptionHTML": "

Returns a token that you can pass to the config script. The token expires after one hour.

\n

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

\n

Example using registration token

\n

Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.

\n
./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -24475,7 +24475,7 @@ "description": "

Created

" } ], - "descriptionHTML": "

Returns a token that you can pass to the config script to remove a self-hosted runner from an enterprise. The token expires after one hour.

\n

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

\n

Example using remove token #

\n

To remove your self-hosted runner from an enterprise, replace TOKEN with the remove token provided by this\nendpoint.

\n
./config.sh remove --token TOKEN\n
" + "descriptionHTML": "

Returns a token that you can pass to the config script to remove a self-hosted runner from an enterprise. The token expires after one hour.

\n

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

\n

Example using remove token

\n

To remove your self-hosted runner from an enterprise, replace TOKEN with the remove token provided by this\nendpoint.

\n
./config.sh remove --token TOKEN\n
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -27295,7 +27295,7 @@ "description": "

Created

" } ], - "descriptionHTML": "

Returns a token that you can pass to the config script. The token expires after one hour.

\n

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

\n

Example using registration token #

\n

Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.

\n
./config.sh --url https://github.com/octo-org --token TOKEN\n
" + "descriptionHTML": "

Returns a token that you can pass to the config script. The token expires after one hour.

\n

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

\n

Example using registration token

\n

Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.

\n
./config.sh --url https://github.com/octo-org --token TOKEN\n
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -28870,7 +28870,7 @@ "description": "

Created

" } ], - "descriptionHTML": "

Returns a token that you can pass to the config script to remove a self-hosted runner from an organization. The token expires after one hour.

\n

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

\n

Example using remove token #

\n

To remove your self-hosted runner from an organization, replace TOKEN with the remove token provided by this\nendpoint.

\n
./config.sh remove --token TOKEN\n
" + "descriptionHTML": "

Returns a token that you can pass to the config script to remove a self-hosted runner from an organization. The token expires after one hour.

\n

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

\n

Example using remove token

\n

To remove your self-hosted runner from an organization, replace TOKEN with the remove token provided by this\nendpoint.

\n
./config.sh remove --token TOKEN\n
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -31716,7 +31716,7 @@ "description": "

Created

" } ], - "descriptionHTML": "

Returns a token that you can pass to the config script. The token expires after one hour. You must authenticate\nusing an access token with the repo scope to use this endpoint.

\n

Example using registration token #

\n

Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.

\n
./config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN\n
" + "descriptionHTML": "

Returns a token that you can pass to the config script. The token expires after one hour. You must authenticate\nusing an access token with the repo scope to use this endpoint.

\n

Example using registration token

\n

Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.

\n
./config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN\n
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -33301,7 +33301,7 @@ "description": "

Created

" } ], - "descriptionHTML": "

Returns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour.\nYou must authenticate using an access token with the repo scope to use this endpoint.

\n

Example using remove token #

\n

To remove your self-hosted runner from a repository, replace TOKEN with the remove token provided by this endpoint.

\n
./config.sh remove --token TOKEN\n
" + "descriptionHTML": "

Returns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour.\nYou must authenticate using an access token with the repo scope to use this endpoint.

\n

Example using remove token

\n

To remove your self-hosted runner from a repository, replace TOKEN with the remove token provided by this endpoint.

\n
./config.sh remove --token TOKEN\n
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -39674,29 +39674,52 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "description": "SHA for the commit", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] }, "tree_id": { - "type": "string" + "type": "string", + "description": "SHA for the commit's tree" }, "message": { - "type": "string" + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] }, "timestamp": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", - "format": "date-time" + "examples": [ + "2014-08-09T08:02:04+12:00" + ] }, "author": { "type": [ "object", "null" ], + "description": "Information about the Git author", "properties": { "name": { - "type": "string" + "description": "Name of the commit's author", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's author", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -39709,12 +39732,22 @@ "object", "null" ], + "description": "Information about the Git committer", "properties": { "name": { - "type": "string" + "description": "Name of the commit's committer", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's committer", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -42410,29 +42443,52 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "description": "SHA for the commit", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] }, "tree_id": { - "type": "string" + "type": "string", + "description": "SHA for the commit's tree" }, "message": { - "type": "string" + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] }, "timestamp": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", - "format": "date-time" + "examples": [ + "2014-08-09T08:02:04+12:00" + ] }, "author": { "type": [ "object", "null" ], + "description": "Information about the Git author", "properties": { "name": { - "type": "string" + "description": "Name of the commit's author", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's author", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -42445,12 +42501,22 @@ "object", "null" ], + "description": "Information about the Git committer", "properties": { "name": { - "type": "string" + "description": "Name of the commit's committer", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's committer", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -45061,29 +45127,52 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "description": "SHA for the commit", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] }, "tree_id": { - "type": "string" + "type": "string", + "description": "SHA for the commit's tree" }, "message": { - "type": "string" + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] }, "timestamp": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", - "format": "date-time" + "examples": [ + "2014-08-09T08:02:04+12:00" + ] }, "author": { "type": [ "object", "null" ], + "description": "Information about the Git author", "properties": { "name": { - "type": "string" + "description": "Name of the commit's author", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's author", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -45096,12 +45185,22 @@ "object", "null" ], + "description": "Information about the Git committer", "properties": { "name": { - "type": "string" + "description": "Name of the commit's committer", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's committer", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -48140,29 +48239,52 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "description": "SHA for the commit", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] }, "tree_id": { - "type": "string" + "type": "string", + "description": "SHA for the commit's tree" }, "message": { - "type": "string" + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] }, "timestamp": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", - "format": "date-time" + "examples": [ + "2014-08-09T08:02:04+12:00" + ] }, "author": { "type": [ "object", "null" ], + "description": "Information about the Git author", "properties": { "name": { - "type": "string" + "description": "Name of the commit's author", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's author", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -48175,12 +48297,22 @@ "object", "null" ], + "description": "Information about the Git committer", "properties": { "name": { - "type": "string" + "description": "Name of the commit's committer", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's committer", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -52716,29 +52848,52 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "description": "SHA for the commit", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] }, "tree_id": { - "type": "string" + "type": "string", + "description": "SHA for the commit's tree" }, "message": { - "type": "string" + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] }, "timestamp": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", - "format": "date-time" + "examples": [ + "2014-08-09T08:02:04+12:00" + ] }, "author": { "type": [ "object", "null" ], + "description": "Information about the Git author", "properties": { "name": { - "type": "string" + "description": "Name of the commit's author", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's author", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -52751,12 +52906,22 @@ "object", "null" ], + "description": "Information about the Git committer", "properties": { "name": { - "type": "string" + "description": "Name of the commit's committer", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's committer", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -156148,29 +156313,52 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "description": "SHA for the commit", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] }, "tree_id": { - "type": "string" + "type": "string", + "description": "SHA for the commit's tree" }, "message": { - "type": "string" + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] }, "timestamp": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", - "format": "date-time" + "examples": [ + "2014-08-09T08:02:04+12:00" + ] }, "author": { "type": [ "object", "null" ], + "description": "Information about the Git author", "properties": { "name": { - "type": "string" + "description": "Name of the commit's author", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's author", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -156183,12 +156371,22 @@ "object", "null" ], + "description": "Information about the Git committer", "properties": { "name": { - "type": "string" + "description": "Name of the commit's committer", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's committer", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -157895,29 +158093,52 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "description": "SHA for the commit", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] }, "tree_id": { - "type": "string" + "type": "string", + "description": "SHA for the commit's tree" }, "message": { - "type": "string" + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] }, "timestamp": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", - "format": "date-time" + "examples": [ + "2014-08-09T08:02:04+12:00" + ] }, "author": { "type": [ "object", "null" ], + "description": "Information about the Git author", "properties": { "name": { - "type": "string" + "description": "Name of the commit's author", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's author", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -157930,12 +158151,22 @@ "object", "null" ], + "description": "Information about the Git committer", "properties": { "name": { - "type": "string" + "description": "Name of the commit's committer", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's committer", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -160842,29 +161073,52 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "description": "SHA for the commit", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] }, "tree_id": { - "type": "string" + "type": "string", + "description": "SHA for the commit's tree" }, "message": { - "type": "string" + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] }, "timestamp": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", - "format": "date-time" + "examples": [ + "2014-08-09T08:02:04+12:00" + ] }, "author": { "type": [ "object", "null" ], + "description": "Information about the Git author", "properties": { "name": { - "type": "string" + "description": "Name of the commit's author", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's author", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -160877,12 +161131,22 @@ "object", "null" ], + "description": "Information about the Git committer", "properties": { "name": { - "type": "string" + "description": "Name of the commit's committer", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's committer", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -162642,29 +162906,52 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "description": "SHA for the commit", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] }, "tree_id": { - "type": "string" + "type": "string", + "description": "SHA for the commit's tree" }, "message": { - "type": "string" + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] }, "timestamp": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", - "format": "date-time" + "examples": [ + "2014-08-09T08:02:04+12:00" + ] }, "author": { "type": [ "object", "null" ], + "description": "Information about the Git author", "properties": { "name": { - "type": "string" + "description": "Name of the commit's author", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's author", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -162677,12 +162964,22 @@ "object", "null" ], + "description": "Information about the Git committer", "properties": { "name": { - "type": "string" + "description": "Name of the commit's committer", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] }, "email": { - "type": "string" + "description": "Git email address of the commit's committer", + "type": "string", + "format": "email", + "examples": [ + "monalisa.octocat@example.com" + ] } }, "required": [ @@ -196564,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", @@ -198210,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", @@ -200914,7 +201211,7 @@ } ], "previews": [], - "descriptionHTML": "

Deployments offer a few configurable parameters with certain defaults.

\n

The ref parameter can be any named branch, tag, or SHA. At GitHub Enterprise Server we often deploy branches and verify them\nbefore we merge a pull request.

\n

The environment parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as production, staging, and qa. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is production.

\n

The auto_merge parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref is behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.

\n

By default, commit statuses for every submitted context must be in a success\nstate. The required_contexts parameter allows you to specify a subset of contexts that must be success, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.

\n

The payload parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.

\n

The task parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe deploy:migrations to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.

\n

Users with repo or repo_deployment scopes can create a deployment for a given ref.

\n

Merged branch response #

\n

You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:

\n\n

If there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.

\n

Merge conflict response #

\n

This error happens when the auto_merge option is enabled and when the default branch (in this case master), can't\nbe merged into the branch that's being deployed (in this case topic-branch), due to merge conflicts.

\n

Failed commit status checks #

\n

This error happens when the required_contexts parameter indicates that one or more contexts need to have a success\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of success.

", + "descriptionHTML": "

Deployments offer a few configurable parameters with certain defaults.

\n

The ref parameter can be any named branch, tag, or SHA. At GitHub Enterprise Server we often deploy branches and verify them\nbefore we merge a pull request.

\n

The environment parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as production, staging, and qa. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is production.

\n

The auto_merge parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref is behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.

\n

By default, commit statuses for every submitted context must be in a success\nstate. The required_contexts parameter allows you to specify a subset of contexts that must be success, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.

\n

The payload parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.

\n

The task parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe deploy:migrations to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.

\n

Users with repo or repo_deployment scopes can create a deployment for a given ref.

\n

Merged branch response

\n

You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:

\n\n

If there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.

\n

Merge conflict response

\n

This error happens when the auto_merge option is enabled and when the default branch (in this case master), can't\nbe merged into the branch that's being deployed (in this case topic-branch), due to merge conflicts.

\n

Failed commit status checks

\n

This error happens when the required_contexts parameter indicates that one or more contexts need to have a success\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of success.

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

Gets information about a GitHub Enterprise Server Pages site.

\n

A token with the repo scope is required. GitHub Apps must have the pages:read permission.

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

Lists builts of a GitHub Enterprise Server Pages site.

\n

A token with the repo scope is required. GitHub Apps must have the pages:read permission.

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

Gets information about the single most recent build of a GitHub Enterprise Server Pages site.

\n

A token with the repo scope is required. GitHub Apps must have the pages:read permission.

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

Gets information about a GitHub Enterprise Server Pages build.

\n

A token with the repo scope is required. GitHub Apps must have the pages:read permission.

", "statusCodes": [ { "httpStatusCode": "200", @@ -437203,7 +437500,7 @@ } ], "previews": [], - "descriptionHTML": "

Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.

\n

Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.

\n

Notes:

\n\n

Size limits #

\n

If the requested file's size is:

\n\n

If the content is a directory #

\n

The response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".

\n

If the content is a symlink #

\n

If the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.

\n

If the content is a submodule #

\n

The submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.

\n

If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.

", + "descriptionHTML": "

Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.

\n

Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.

\n

Notes:

\n\n

Size limits

\n

If the requested file's size is:

\n\n

If the content is a directory

\n

The response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".

\n

If the content is a symlink

\n

If the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.

\n

If the content is a submodule

\n

The submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.

\n

If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.

", "statusCodes": [ { "httpStatusCode": "200", @@ -447442,7 +447739,7 @@ } ], "previews": [], - "descriptionHTML": "

Searches for query terms inside of a file. This method returns up to 100 results per page.

\n

When searching for code, you can get text match metadata for the file content and file path fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

\n

For example, if you want to find the definition of the addClass function inside jQuery repository, your query would look something like this:

\n

q=addClass+in:file+language:js+repo:jquery/jquery

\n

This query searches for the keyword addClass within a file's contents. The query limits the search to files where the language is JavaScript in the jquery/jquery repository.

\n

Considerations for code search #

\n

Due to the complexity of searching code, there are a few restrictions on how searches are performed:

\n", + "descriptionHTML": "

Searches for query terms inside of a file. This method returns up to 100 results per page.

\n

When searching for code, you can get text match metadata for the file content and file path fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

\n

For example, if you want to find the definition of the addClass function inside jQuery repository, your query would look something like this:

\n

q=addClass+in:file+language:js+repo:jquery/jquery

\n

This query searches for the keyword addClass within a file's contents. The query limits the search to files where the language is JavaScript in the jquery/jquery repository.

\n

Considerations for code search

\n

Due to the complexity of searching code, there are a few restrictions on how searches are performed:

\n", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/lib/config.json b/src/rest/lib/config.json index 294c99f7b3..10bb729f47 100644 --- a/src/rest/lib/config.json +++ b/src/rest/lib/config.json @@ -30,5 +30,5 @@ ] } }, - "sha": "9ebe01d1bd3b3b323f2fbbf18f77b0c49f94c442" + "sha": "32e8e407fdb3957859a03ae38a6c0bd6513f3c7e" } \ No newline at end of file diff --git a/src/webhooks/data/fpt/schema.json b/src/webhooks/data/fpt/schema.json index c75b17999b..88f8e6030f 100644 --- a/src/webhooks/data/fpt/schema.json +++ b/src/webhooks/data/fpt/schema.json @@ -74229,7 +74229,7 @@ "type": "object", "name": "merge_group", "in": "body", - "description": "", + "description": "

A group of pull requests that the merge queue has grouped together to be merged.

", "isRequired": true, "childParamsGroups": [ { @@ -74259,92 +74259,72 @@ { "type": "object", "name": "head_commit", - "description": "", + "description": "

A commit.

", "isRequired": true, "childParamsGroups": [ - { - "type": "object", - "name": "author", - "description": "

Metaproperties for Git author/committer information.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "date", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The git author's name.

", - "isRequired": true - }, - { - "type": "string", - "name": "username", - "description": "" - } - ] - }, - { - "type": "object", - "name": "committer", - "description": "

Metaproperties for Git author/committer information.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "date", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The git author's name.

", - "isRequired": true - }, - { - "type": "string", - "name": "username", - "description": "" - } - ] - }, { "type": "string", "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "message", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "timestamp", - "description": "", + "description": "

SHA for the commit

", "isRequired": true }, { "type": "string", "name": "tree_id", - "description": "", + "description": "

SHA for the commit's tree

", "isRequired": true + }, + { + "type": "string", + "name": "message", + "description": "

Message describing the purpose of the commit

", + "isRequired": true + }, + { + "type": "string", + "name": "timestamp", + "description": "

Timestamp of the commit

", + "isRequired": true + }, + { + "type": "object or null", + "name": "author", + "description": "

Information about the Git author

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "name", + "description": "

Name of the commit's author

", + "isRequired": true + }, + { + "type": "string", + "name": "email", + "description": "

Git email address of the commit's author

", + "isRequired": true + } + ] + }, + { + "type": "object or null", + "name": "committer", + "description": "

Information about the Git committer

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "name", + "description": "

Name of the commit's committer

", + "isRequired": true + }, + { + "type": "string", + "name": "email", + "description": "

Git email address of the commit's committer

", + "isRequired": true + } + ] } ] } @@ -74377,6 +74357,172 @@ ], "action": "checks_requested", "category": "merge_group" + }, + "destroyed": { + "descriptionHtml": "

The merge queue groups pull requests together to be merged. This event indicates that one of those merge groups was destroyed. This happens when a pull request is removed from the queue: any group containing that pull request is also destroyed.

\n

When you receive this event, you may want to cancel any checks that are running on the head SHA to avoid wasting computing resources on a merge group that will not be used.

", + "summaryHtml": "

This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"Managing a merge queue.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.

\n

Note: The pull request merge queue feature is currently in public beta and subject to change.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "destroyed" + ], + "childParamsGroups": [] + }, + { + "type": "string", + "name": "reason", + "in": "body", + "description": "

Explains why the merge group is being destroyed. The group could have been merged, removed from the queue (dequeued), or invalidated by an earlier queue entry being dequeued (invalidated).

", + "enum": [ + "merged", + "invalidated", + "dequeued" + ] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "merge_group", + "in": "body", + "description": "

A group of pull requests that the merge queue has grouped together to be merged.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "head_sha", + "description": "

The SHA of the merge group.

", + "isRequired": true + }, + { + "type": "string", + "name": "head_ref", + "description": "

The full ref of the merge group.

", + "isRequired": true + }, + { + "type": "string", + "name": "base_sha", + "description": "

The SHA of the merge group's parent commit.

", + "isRequired": true + }, + { + "type": "string", + "name": "base_ref", + "description": "

The full ref of the branch the merge group will be merged into.

", + "isRequired": true + }, + { + "type": "object", + "name": "head_commit", + "description": "

A commit.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "id", + "description": "

SHA for the commit

", + "isRequired": true + }, + { + "type": "string", + "name": "tree_id", + "description": "

SHA for the commit's tree

", + "isRequired": true + }, + { + "type": "string", + "name": "message", + "description": "

Message describing the purpose of the commit

", + "isRequired": true + }, + { + "type": "string", + "name": "timestamp", + "description": "

Timestamp of the commit

", + "isRequired": true + }, + { + "type": "object or null", + "name": "author", + "description": "

Information about the Git author

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "name", + "description": "

Name of the commit's author

", + "isRequired": true + }, + { + "type": "string", + "name": "email", + "description": "

Git email address of the commit's author

", + "isRequired": true + } + ] + }, + { + "type": "object or null", + "name": "committer", + "description": "

Information about the Git committer

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "name", + "description": "

Name of the commit's committer

", + "isRequired": true + }, + { + "type": "string", + "name": "email", + "description": "

Git email address of the commit's committer

", + "isRequired": true + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "childParamsGroups": [] + } + ], + "availability": [ + "app" + ], + "action": "destroyed", + "category": "merge_group" } }, "meta": { diff --git a/src/webhooks/data/ghec/schema.json b/src/webhooks/data/ghec/schema.json index 1b4d8cd939..e2d97360ed 100644 --- a/src/webhooks/data/ghec/schema.json +++ b/src/webhooks/data/ghec/schema.json @@ -74229,7 +74229,7 @@ "type": "object", "name": "merge_group", "in": "body", - "description": "", + "description": "

A group of pull requests that the merge queue has grouped together to be merged.

", "isRequired": true, "childParamsGroups": [ { @@ -74259,92 +74259,72 @@ { "type": "object", "name": "head_commit", - "description": "", + "description": "

A commit.

", "isRequired": true, "childParamsGroups": [ - { - "type": "object", - "name": "author", - "description": "

Metaproperties for Git author/committer information.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "date", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The git author's name.

", - "isRequired": true - }, - { - "type": "string", - "name": "username", - "description": "" - } - ] - }, - { - "type": "object", - "name": "committer", - "description": "

Metaproperties for Git author/committer information.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "date", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The git author's name.

", - "isRequired": true - }, - { - "type": "string", - "name": "username", - "description": "" - } - ] - }, { "type": "string", "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "message", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "timestamp", - "description": "", + "description": "

SHA for the commit

", "isRequired": true }, { "type": "string", "name": "tree_id", - "description": "", + "description": "

SHA for the commit's tree

", "isRequired": true + }, + { + "type": "string", + "name": "message", + "description": "

Message describing the purpose of the commit

", + "isRequired": true + }, + { + "type": "string", + "name": "timestamp", + "description": "

Timestamp of the commit

", + "isRequired": true + }, + { + "type": "object or null", + "name": "author", + "description": "

Information about the Git author

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "name", + "description": "

Name of the commit's author

", + "isRequired": true + }, + { + "type": "string", + "name": "email", + "description": "

Git email address of the commit's author

", + "isRequired": true + } + ] + }, + { + "type": "object or null", + "name": "committer", + "description": "

Information about the Git committer

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "name", + "description": "

Name of the commit's committer

", + "isRequired": true + }, + { + "type": "string", + "name": "email", + "description": "

Git email address of the commit's committer

", + "isRequired": true + } + ] } ] } @@ -74377,6 +74357,172 @@ ], "action": "checks_requested", "category": "merge_group" + }, + "destroyed": { + "descriptionHtml": "

The merge queue groups pull requests together to be merged. This event indicates that one of those merge groups was destroyed. This happens when a pull request is removed from the queue: any group containing that pull request is also destroyed.

\n

When you receive this event, you may want to cancel any checks that are running on the head SHA to avoid wasting computing resources on a merge group that will not be used.

", + "summaryHtml": "

This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"Managing a merge queue.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.

\n

Note: The pull request merge queue feature is currently in public beta and subject to change.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "destroyed" + ], + "childParamsGroups": [] + }, + { + "type": "string", + "name": "reason", + "in": "body", + "description": "

Explains why the merge group is being destroyed. The group could have been merged, removed from the queue (dequeued), or invalidated by an earlier queue entry being dequeued (invalidated).

", + "enum": [ + "merged", + "invalidated", + "dequeued" + ] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "merge_group", + "in": "body", + "description": "

A group of pull requests that the merge queue has grouped together to be merged.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "head_sha", + "description": "

The SHA of the merge group.

", + "isRequired": true + }, + { + "type": "string", + "name": "head_ref", + "description": "

The full ref of the merge group.

", + "isRequired": true + }, + { + "type": "string", + "name": "base_sha", + "description": "

The SHA of the merge group's parent commit.

", + "isRequired": true + }, + { + "type": "string", + "name": "base_ref", + "description": "

The full ref of the branch the merge group will be merged into.

", + "isRequired": true + }, + { + "type": "object", + "name": "head_commit", + "description": "

A commit.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "id", + "description": "

SHA for the commit

", + "isRequired": true + }, + { + "type": "string", + "name": "tree_id", + "description": "

SHA for the commit's tree

", + "isRequired": true + }, + { + "type": "string", + "name": "message", + "description": "

Message describing the purpose of the commit

", + "isRequired": true + }, + { + "type": "string", + "name": "timestamp", + "description": "

Timestamp of the commit

", + "isRequired": true + }, + { + "type": "object or null", + "name": "author", + "description": "

Information about the Git author

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "name", + "description": "

Name of the commit's author

", + "isRequired": true + }, + { + "type": "string", + "name": "email", + "description": "

Git email address of the commit's author

", + "isRequired": true + } + ] + }, + { + "type": "object or null", + "name": "committer", + "description": "

Information about the Git committer

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "name", + "description": "

Name of the commit's committer

", + "isRequired": true + }, + { + "type": "string", + "name": "email", + "description": "

Git email address of the commit's committer

", + "isRequired": true + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "childParamsGroups": [] + } + ], + "availability": [ + "app" + ], + "action": "destroyed", + "category": "merge_group" } }, "meta": { diff --git a/src/webhooks/lib/config.json b/src/webhooks/lib/config.json index 3d75c3cbee..a57bca0cc1 100644 --- a/src/webhooks/lib/config.json +++ b/src/webhooks/lib/config.json @@ -1,3 +1,3 @@ { - "sha": "9ebe01d1bd3b3b323f2fbbf18f77b0c49f94c442" + "sha": "32e8e407fdb3957859a03ae38a6c0bd6513f3c7e" } \ No newline at end of file